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

[mmd]

> Is it just get requests that can be tested? I'm concerned because other systems I'm more familiar with that allow online testing like this either have a 'test mode' API, or it's only your own account that you can mess up by playing around while logged in. On the flip side, if all you can test are get requests, it becomes a bit less interesting! Do you have any details on this?

You can spin up a _Swagger Petstore_ test frontend at https://editor.swagger.io/  and try out common HTTP verbs (GET, POST, PUT, PATCH, DELETE, ...) + authorization to get some idea how this works. For testing purposes, a few test endpoints could be included, such as http://localhost:3000 and https://master.apis.dev.openstreetmap.org/. Users can then try things out use their own credentials.


-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/issues/3107#issuecomment-790891912
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20210304/0c824ac4/attachment.htm>