Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate and publish OpenAPI documentation for Explorer Users #618

Open
omad opened this issue Jul 12, 2024 · 0 comments
Open

Generate and publish OpenAPI documentation for Explorer Users #618

omad opened this issue Jul 12, 2024 · 0 comments

Comments

@omad
Copy link
Member

omad commented Jul 12, 2024

It would be great if an Explorer instance could publish it's own documentation on the API endpoints it provides.

This should be generated based on the actual code, and published as an OpenAPI specification.

Ideally, as well as the OpenAPI spec, there should be a nice UI provided by something like with ReDoc or Swagger UI.

At the very least we need the STAC API endpoints documented, but there's probably a few others should be included too.

There are a multitude of libraries for adding this to Flask, I'm not sure which to pick. Maybe flasgger which is popular, or flask-smorest.

We could also work out how hard a conversion from Flask to FastAPI would be, since it includes built in OpenAPI/UI support, as well as being new and fast and cool. There's probably some nasty gotchas to beware of though, so not something to undertake lightly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant