https://github.com/digitalnodecom/couchdb-swagger

Script to scrape CouchDB documentation and convert it to OpenAPI 3 / Swagger format.
https://github.com/digitalnodecom/couchdb-swagger

Last synced: about 2 months ago
JSON representation

Script to scrape CouchDB documentation and convert it to OpenAPI 3 / Swagger format.

• Host: GitHub
• URL: https://github.com/digitalnodecom/couchdb-swagger
• Owner: digitalnodecom
• Created: 2024-03-17T11:00:27.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-03-17T11:33:33.000Z (9 months ago)
• Last Synced: 2024-03-18T12:38:38.761Z (9 months ago)
• Language: PHP
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CouchDB Swagger Generator

This PHP CLI script will scrape [CouchDB API documentation](https://docs.couchdb.org/en/stable/api/index.html) and generate a Swagger 3.0 file. You can find the file in this repository as well under [couchdb.json](https://raw.githubusercontent.com/digitalnodecom/couchdb-swagger/master/couchdb.json). 

## Usage

If you want to generate the file yourself, you can run the following command:

```php

php cli.php > couchdb.json

```

## Notes

- /{db}/_design/{ddoc}/_rewrite/{path} uses the HTTP method 'any'. This is not supported and we replaced it with _post_.

- Some of the API calls have the HTTP method 'copy'. These have been removed.