provide openapi document and link from homepage

geonetwork / geonetwork-microservices

GNU General Public License v2.0

13 stars 18 forks source link

provide openapi document and link from homepage #35

Open pvgenuchten opened 3 years ago

pvgenuchten commented 3 years ago

Add an interactive openapi document at /ogcapi/openapi and link to it from /ogcapi

Links should be annotated as rel=service-desc && rel=service-doc, see example at https://demo.pygeoapi.io/master?f=json

[x] on /ogcapi page, create a link to /ogcapi/openapi
[x] /ogcapi/openapi?f=html should return the interactive api page
[x] /ogcapi/openapi?f=json should return the json encoded OAS document
[ ] add /ogcapi/openapi itself to the openapi document
[ ] add /ogcapi/conformance to the openapi document

fxprunayre commented 3 years ago

We will have to discuss how we build the global API of the microservices - how we can combine APIs from different services, how to "combine" with GN4 API ... We can start first by not building Java client from the not up to date yml document and build the openAPI using Springfox like in GN4.

Maybe we have to tag "extensions" so we can more easily follow what is core OGC API Records and what is GN specific.

pvgenuchten commented 3 years ago

In standup decided to not use central schema-files but generate with springfox

fxprunayre commented 3 years ago

Some of the fixes done in https://github.com/geonetwork/geonetwork-microservices/commit/ffd9845e7247a3e50f6748992cd5be5f0578d982