Create OpenAPI specs for rest API

Esri / geoportal-server

Geoportal Server is a standards-based, open source product that enables discovery and use of geospatial resources including data and services.

https://gptogc.esri.com/geoportal

Apache License 2.0

244 stars 149 forks source link

Create OpenAPI specs for rest API #297

Open ioggstream opened 6 years ago

ioggstream commented 6 years ago

I wish

to have an openapi spec for geoportal-server
the openapi.yaml represents in a usable way the informations in https://github.com/Esri/geoportal-server/wiki/REST-API-Syntax

mhogeweg commented 6 years ago

out of curiosity: do you have client applications that would use this openapi spec to auto-discover geoportal search capabilities? what is the goal of doing this?

gcampanile commented 6 years ago

I have a client that explicitly asked for an OpenAPI spec; it's a public authority and the reason is to provide a common API to query all their services.

ioggstream commented 6 years ago

having a standardized interface:

clarifies usage pattern with multiple examples
can be validated via a linter
allows api to be viewable from a catalog (eg. https://api.gouv.fr/api/le-taxi.html)