apache
Swagger UI or Postman Collection
Expected Behavior
I think would be useful if we have a postman collection to interact with the CouchDB database, avoid a lot of copying and pasting from documentation and also support code generation.
Current Behavior
Possible Solution
I am creating one for my projects if the community agree that is useful I am volunteer to maintain
Steps to Reproduce (for bugs)
Context
Your Environment
- Version used:
- Browser Name and version:
- Operating System and version (desktop or mobile):
- Link to your project:
Hi, sounds like a good idea. Is this a manual process of writing and maintaining the docs for the endpoints?
Hi, @big-r81, currently is a manual process and has some drawbacks like the lack of details compared to the main documentation, but it also has benefits like code generation and we are able to interact directly. My plan is to release the first iteration on September 15th.
@RafaelFigueiredo can you post the link to the project where you have the swagger for CouchDB API? I am trying to do the same thing: swagger documentation for CouchDB API and I am more then happy to contribute if you have something ongoing. Otherwise, I will start a new project to document:
- swagger CouchDB API
- JSON schema for JSON objects (requests and responses)
There is a Postman collection here: https://www.postman.com/galactic-comet-36406/workspace/couchdb/collection/15985155-f511300e-848e-4ab2-a0a2-da13cb2e1065
We wrote a script that scrapes docs and converts it to OpenAPI 3.x: https://github.com/digitalnodecom/couchdb-swagger
You have the couchdb.json file if you don't want to run the script yourself.
There is a Postman collection here: https://www.postman.com/galactic-comet-36406/workspace/couchdb/collection/15985155-f511300e-848e-4ab2-a0a2-da13cb2e1065
@dragos-constantin-stoica, this collection is the one I created.
@trajche nice working on the generator.
I was thinking of something like this https://hexdocs.pm/open_api_spex/3.4.0/readme.html, but I don't see direct support for Erlang.