Swagger UI or Postman Collection

apache / couchdb

Seamless multi-master syncing database with an intuitive HTTP/JSON API, designed for reliability

https://couchdb.apache.org/

Apache License 2.0

6.17k stars 1.03k forks source link

Swagger UI or Postman Collection #4213

Open RafaelFigueiredo opened 2 years ago

RafaelFigueiredo commented 2 years ago

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
Screen Shot 2022-08-18 at 00 53 39

Steps to Reproduce (for bugs)

1. 2. 3. 4.

Context

Your Environment

Version used:
Browser Name and version:
Operating System and version (desktop or mobile):
Link to your project:

big-r81 commented 2 years ago

Hi, sounds like a good idea. Is this a manual process of writing and maintaining the docs for the endpoints?

RafaelFigueiredo commented 2 years ago

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.

dragos-constantin-stoica commented 9 months ago

@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

trajche commented 6 months ago

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.

RafaelFigueiredo commented 5 months ago

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.