lucybot-inc / documentation-starter Goto Github PK

View Code? Open in Web Editor NEW

176.0 13.0 59.0 6.86 MB

Interactive REST API Documentation

Home Page: http://lucybot.com

License: Other

HTML 100.00%

api-documentation api-documentation-tool openapi openapi-documentation rest-api

documentation-starter's Introduction

LucyBot Starter API Console

This is the default build for LucyBot's API Documentation. It can be used in non-commercial projects, or for demo purposes.

Check out the Pet Store demo

Commercial licenses and additional features are available at lucybot.com

Usage

Simply fork this repository and replace openapi.json with your OpenAPI specification.

git clone https://github.com/LucyBot-Inc/documentation-starter
cp /path/to/my/openapi.json documentation-starter/openapi.json

Have RAML, WADL, API Blueprint, or I/O Docs? Check out api-spec-converter

Serving

You can serve the website with any static HTTP server.

e.g. with http-server

npm install -g http-server
http-server ./documentation-starter

or with PHP:

php -S 0.0.0.0:80 -t ./documentation-starter

The easiest way to serve the documentation publicly is with GitHub pages: in your fork, visit the Settings page, and choose "master branch" as the source in the GitHub Pages section. You can also set a custom domain there.

You can also serve this directory with Apache, NodeJS Express, etc.

Customization

Title and Description

The API title and description are controlled by the info field in openapi.json. You can use Markdown in the description.

Themes

You can use your own Bootstrap theme to customize colors, fonts, sizes, and more. Just replace dist/bootstrap.css with your own bootstrap.css

You can generate a bootstrap.css file using:

The full commercial version offers several additional features:

Additional Markdown/HTML sections
Custom navbar and footer
Custom homepage
Event tracking
SEO (<meta> and <title> tags, sitemap.xml)
User authentication
Galleries for multiple APIs

For a full list of features available see lucybot.com

License

Creative Commons 4.0 - Non-commercial

For a commercial license, contact us

documentation-starter's People

Contributors

Stargazers

Watchers

Forkers

pavelsusloparovnyt steveax nubiofs bungalowinsurance nicedreamer digideskio ilopezluna bigdatadig 9kopb yezero wshirey akosenn robb33 seinsfrage cowboysdude tim-trueai abebars fredide alivarzeshi drexler ancyabraham ahadmontazeri69 cartagena-data-science alexfrosa yoyo2011 gmolina4thsource ssudweeks mohit-particle41 rrjoaofrancisco sheac gideon-grossman plittlewood-rpt juliajohns andrii-dubytskyi braniton babacar29 regikul yadav-avanish michaelonlr kreasialamteknologi dicolasi apizone-projects ahaq0 ehaic onenos-com wagner-rebello hlittle nimishshete93 paulatflexa felixvd ccostopoulos djamol mohammednayeemprodian gsamarascs abhishek-s20 runarad maxasus123 blueguardianit mq91

documentation-starter's Issues

Remove proxy for 'api-models'

I create gh-pages branch for api-models repo.
So you can use links like http://apis-guru.github.io/api-models/googleapis.com/drive/v2/swagger.json
to access specs. gh-pages support compression and Access-Control-Allow-Origin: * so you can remove proxy.
If this will work as expected I will remove master branch and make `gh-pages' main branch.

Use ngRoute

Pages should use fragments for #documentation and #console tabs, and for each individual endpoint

[Unsure] support for OpenAPI v. 3.0.0

I have an OpenAPI specification v. 3.0.0 in YAML format. I converted it to JSON and put into the root directory as suggested, but the rendering I see is very poor, it only contains the top-level list of methods and that's all. If I click on a method, it shows method's description, list of parameters and response code tabs, but everything with empty content.

I am wondering if it is something related to my JSON file and how it can be fixed. Does the tool support "openapi": "3.0.0" at all?

Compress content

This is good article http://blog.modulus.io/nodejs-and-express-static-content

Improve customizability

Expose specific CSS classes or LESS variables to override

Migrate from CSS to LESS

This will help consoles take better advantage of user-defined variables

Fix link to swagger file

https://github.com/bobby-brennan/lucy-console/blob/b6807cd4cc2bab1ed497da5b37a2a1ad45a90d93/views/includes/spec-link.jade#L3

should be changed to 'https://apis-guru.github.io/api-models/'

Not able to pickup my openapi.json file

Hi Team,

I tried to configure lucyBot(https://github.com/LucyBot-Inc/documentation-starter.git) in my local system and it worked with petstore example as expected but when I tried to update openApi.json file with my content it is not taking it up though I restarted server,cleared cache. can you help me if I am doing anythin wrong ?