Skip to content

darklynx/swagger-api-collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

REST API Collection

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

API descriptions for different RESTful APIs could be found in:

Collection

Currently available API descriptions:

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.

Releases

No releases published

Packages

No packages published