REST API Collection

June 15, 2022 · View on GitHub

My collection of RESTful API descriptions in Open API (former Swagger) format.

API descriptions for different RESTful APIs could be found in:

api/yaml - contains API descriptions in YAML Open API format
api/json - contains API descriptions in JSON Open API format, automatically generated from YAML with a help of swagger-codegen project

Collection

Currently available API descriptions:

instagram.yaml - Instagram API description
dropbox-core.yaml - Dropbox Core API v1 description
dropbox-content.yaml - Dropbox Core API v1 description; content end-point
dropbox-notify.yaml - Dropbox Core API v1 description; notify end-point

Browser

This project contains a simple HTML page that renders REST APIs with a help of ReDoc library.

Simply launch a web-server that targets a root directory and open index.html in any browser, or use the provided bash script:

$ ./browse.sh

Python 3.x

Python 3.x comes with a prebuild HTTP server:

$ python3 -m http.server 8000
Serving HTTP on :: port 8000 (http://[::]:8000/) ...

Now you can open a browser and go to the URL: http://localhost:8000/

Twisted

Twisted is a cross-platform event-driven networking engine written in Python:

$ twistd -no web --path=.
2015-06-20 00:09:13+0200 [-] Log opened.
2015-06-20 00:09:13+0200 [-] twistd 14.0.2 (/usr/bin/python 2.7.9) starting up.
2015-06-20 00:09:13+0200 [-] reactor class: twisted.internet.epollreactor.EPollReactor.
2015-06-20 00:09:13+0200 [-] Site starting on 8080

Now you can open a browser and go to the URL: http://localhost:8080/

NodeJS

Install node.js if you haven't already. Then use the node package manager (npm) to install the http-server package:

$ npm install http-server -g

Launch the server with following command:

$ http-server .
Starting up http-server, serving . on: http://0.0.0.0:8080
Hit CTRL-C to stop the server

Now you can open a browser and go to the URL: http://localhost:8080/

Other alternatives

If you didn't like anything from above, please have a look at the big list of HTTP static server one-liners

License

The API descriptions in YAML and JSON Swagger format are desctributed under MIT license that could be found in api/ folder.