gbv / format.gbv.de

Formatdatenbank
https://format.gbv.de/
GNU General Public License v3.0
7 stars 4 forks source link

Document Avram API with OpenAPI, request and response format to be defined #29

Closed nichtich closed 2 years ago

nichtich commented 6 years ago

The API to query PICA/MARC/MAB fields needs to be refactored anyway (#23). Parameters could be:

However endpoints for selected schemas (e.g. MARC21 bibliographic) are more convenient. The endpoint should tell which schema its results come from, e.g.:

{
  "http://format.gbv.de/pica/zdb-address/schema.json": {
    "format": "http://format.gbv.de/pica/zdb-address",
    "fields": { ... }
  },
  "http://example.org/another-schema.json": {
    "format": "uri:of:the:format:defined:by:this:schema",
    "fields": { ... }
  }
}

or

[
  { 
    "source": "http://format.gbv.de/pica/zdb-address/schema.json",
    "format": "http://format.gbv.de/pica/zdb-address",
    "fields": { ... }
  },
  {
    "source": "http://example.org/another-schema.json",
    "format": "uri:of:the:format:defined:by:this:schema",
    "fields": { ... }
  }
]
nichtich commented 2 years ago

Avram API has been moved to https://format.k10plus.de/avram.pl