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

[mmd]

mmd-osm left a comment (openstreetmap/openstreetmap-website#3107)

The two screenshots I posted initially were based on a similar approach (obviously without using chatgpt back then). The main goal was to declare the API structure, in order to extract it as OpenAPI format (OAS3) later on.

I haven't explored the option to use RSpec for actual tests. I can't comment if there might be some longer term synergies in doing so. In our case it will be mainly adding some declaration on top of what we already have, rather than reusing or rewriting existing tests. This could be done over time, adding further API endpoints as time permits.

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

Message ID: <openstreetmap/openstreetmap-website/issues/3107/2830240789 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20250425/80c02fef/attachment-0001.htm>