Skip to content

Redoc UI implementation for cbSwagger. Inspired by the cbSwaggerUI module by Daniel Garcia

License

Notifications You must be signed in to change notification settings

homestar9/cbswagger-redoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cbswagger-redoc

Redoc Logo

This is the Swagger Redoc UI module for ColdBox applications. It was inspired by the cbSwaggerUI module. By default, it looks in the /cbswagger location for the OpenAPI Swagger file.

The UI is available at /redoc - where you will see a visual representation of your Swagger docs.

Redoc Screenshot

Important links

Install cbswgger-redoc (via Commandbox)

box install cbswagger-redoc

Note: Omit the box from your command, if you are already in the Commandbox interactive shell

Configuration

If you just want to use this with cbSwagger, there is nothing else to configure (assuming you have cbSwagger installed.)

You can optionaly configure the following settings:

swaggerFile

The location for the swagger JSON file you want to render.

Default: "/cbswagger"

title

The title of your API project.

Example ColdBox.cfc configuration:

moduleSettings = {
    cbSwaggerRedoc : {
        "swaggerFile" : "/cbswagger",
        "title" : "My Cool API"
    }
};

Roadmap

  • Execute requests from the browser
  • Display personalized logo from x-logo
  • Basic security to limit access (possibly cbsecurity?)
  • Ability to render a static HTML page/site

About

Redoc UI implementation for cbSwagger. Inspired by the cbSwaggerUI module by Daniel Garcia

Resources

License

Stars

Watchers

Forks

Packages

No packages published