https://github.com/JakeWorrell/docodile

Generate HTML API documentation from a Postman collection
https://github.com/JakeWorrell/docodile

api api-documentation documentation html php postman-collection rest

Last synced: 14 days ago
JSON representation

Generate HTML API documentation from a Postman collection

• Host: GitHub
• URL: https://github.com/JakeWorrell/docodile
• Owner: JakeWorrell
• License: mit
• Created: 2014-12-18T09:31:53.000Z (almost 10 years ago)
• Default Branch: develop
• Last Pushed: 2021-07-16T10:24:09.000Z (over 3 years ago)
• Last Synced: 2024-08-01T16:47:09.345Z (3 months ago)
• Topics: api, api-documentation, documentation, html, php, postman-collection, rest
• Language: PHP
• Size: 447 KB
• Stars: 69
• Watchers: 7
• Forks: 22
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docodile

Generate HTML API documentation from a Postman collection

Code is terrible at the moment

Usage

-----

Don't forget to run a ```composer install``` first

```./docodile generate /path/to/postman/collection.json /my/output/directory```

if ```/my/output/directory``` already exists the process will exit as continuing will delete that directory completely. --force will force deletion

--url: add option for url. e.g. "http://helloworld.com"

Theming

-------

Docodile now supports switching of themes from bootswatch (https://bootswatch.com/3/) and highlightjs' bundled styles (https://highlightjs.org/)

For example:

```./docodile generate ../core/webservice/docs/Core.json.postman_collection output --force -blumen -jgruvbox-light```

this will use the lumen theme for the overall css and the gruvbox-light style for all syntax highlighting