[openstreetmap/openstreetmap-website] Documenting API using Swagger / rswag (#3107)

[Pablo Brasero]

pablobm left a comment (openstreetmap/openstreetmap-website#3107)

Another candidate for this task: https://github.com/openapi-ruby/openapi-ruby. Quick thoughts from the readme, without properly trying it out:
- It supports Minitest, as opposed to only RSpec.
- Schemas declared in a Ruby DSL, separate from the tests themselves.
- Can serve a Swagger UI interface.
- Commits show heavy use of commercial LLM coding tools.
	- Relevant since, as LLM companies start charging users for their actual use, projects that depend on these tools could stop being maintained. Plus other common questions.
- As of these lines: 5 stars, no issues ever filed, about 2 months old.
- Not sure about the facility to test the schema within integration tests. I think I'd simply enable the schema during normal controller/integration API tests and let it crash when the format is not fulfilled. But would need to play with it more.

-- 
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/issues/3107#issuecomment-4648228058
You are receiving this because you are subscribed to this thread.

Message ID: <openstreetmap/openstreetmap-website/issues/3107/4648228058 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20260608/3878748d/attachment.htm>