search

komoot / photon

an open source geocoder for openstreetmap data
Apache License 2.0
1.83k stars 278 forks source link

Provide OpenAPI specs #550

Open debuglevel opened 3 years ago

debuglevel commented 3 years ago

It would be nice if the API provides an endpoint to an OpenAPI specification. This would facilitate code generation for client libraries.

Unfortunately - if Spark did not change much since I used it - it does not support this out of the box. Therefore it would require manual work. There is also https://github.com/manusant/spark-swagger, but I never tried it back then.

KiwiKilian commented 5 months ago

Here is the OpenAPI Spec we use https://gist.github.com/KiwiKilian/1f9d35544a7e9312bb74bd75a889df9c.

I don't know anything about spark, therefore I could only contribute the manually created spec. But at least some Swagger UI would be necessary for proper display in the Docs?

danielgit0 commented 3 weeks ago

Hi, in the meantime, here is a small update with the status endpoint

openapi.json