Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp
www.coldbox.org |
www.ortussolutions.com
This module automatically generates OpenAPI ( fka Swagger ) documenation from your configured application and module routes. This module utilizes the v3.0.2 OpenAPI Specification
Apache License, Version 2.0.
- https://swagger.io/specification
- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
- https://idratherbewriting.com/learnapidoc/pubapis_openapi_tutorial_overview
- https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/
- Lucee 5+
- Adobe ColdFusion 2016+
To operate, the module requires that SES routing be enabled in your application. For more information read the official documentation.
box install cbswagger
Note: Omit the
boxfrom your command, if you are already in the Commandbox interactive shell
By default, cbswagger looks for routes beginning with /api/* prefix. By adding a cbswagger configuration key to your Coldbox configuration, you can add additional metadata to the OpenAPI JSON produced by the module entry point and configure this module for operation.
routes:array: An array of route prefixes to search for and add to the resulting documentation.defaultFormat:string: The default output format of the documentation. Valid options arejsonandyml.
A full configuration example is provided below:
cbswagger = {
// The route prefix to search. Routes beginning with this prefix will be determined to be api routes
"routes" : [ "api" ],
// The default output format: json or yml
// Routes to exclude by prefix. Routes beginning with this prefix will be excluded
"excludeRoutesPrefix" : [ "cbswagger", "relax" ],
// Any routes to exclude - may use exact matches or globbing patterns e.g `[ "api/v1/mysecret" ]` or `[ "**/secret", "**/undocumented" ]` (no initial `/`, trailing `/` optional for routes)
"excludeRoutes" : [],
// Routes to exclude based on event
"excludeEvents" : [],
"defaultFormat" : "json",
// A convention route, relative to your app root, where request/response samples are stored ( e.g. resources/apidocs/responses/[module].[handler].[action].[HTTP Status Code].json )
"samplesPath" : "resources/apidocs",
// Information about your API
"info" :{
// A title for your API
"title" : "My Awesome API",
// A description of your API
"description" : "This API produces amazing results and data.",
// A terms of service URL for your API
"termsOfService" : "",
//The contact email address
"contact" :{
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "info@ortussolutions.com"
},
//A url to the License of your API
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
//The version of your API
"version":"1.0.0",
// https://swagger.io/specification/#externalDocumentationObject
"externalDocs" : {
"description": "Find more info here",
"url": "https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/"
}
},
// Tags
"tags" : [
{
"name": "pet",
"description": "Pets operations"
}
],
// https://swagger.io/specification/#serverObject
"servers" : [
{
"url" : "https://mysite.com/v1",
"description" : "The main production server"
},
{
"url" : "http://127.0.0.1:60299",
"description" : "The dev server"
}
],
// An element to hold various schemas for the specification.
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#componentsObject
"components" : {
// Define your security schemes here
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securitySchemeObject
"securitySchemes" : {
"UserSecurity" : {
// REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
"type" : "http",
// A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
"description" : "HTTP Basic auth",
// REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
"scheme" : "basic"
},
"APIKey" : {
"type" : "apiKey",
"description" : "An API key for security",
"name" : "x-api-key",
"in" : "header"
}
}
},
// A default declaration of Security Requirement Objects to be used across the API.
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#securityRequirementObject
// Only one of these requirements needs to be satisfied to authorize a request.
// Individual operations may set their own requirements with `@security`
"security" : [
{ "APIKey" : [] },
{ "UserSecurity" : [] }
]
};You can visit the API documentation by hitting the /cbswagger route. This will trigger the default format (json) to be sent to the output.
You can force the format by using the ?format={format} in the URI. The valid options are json and yml
http://localhost/cbswagger?format=yml
http://localhost/cbswagger?format=json
http://localhost/cbswagger/json
http://localhost/cbswagger/yml
cbswagger will automatically introspect your API handlers provided by your routing configuration. You may provide additional function attributes (metadata), which will be picked up and included in your documentation.
The content body of these function metadata/attributes may be provided as:
- JSON
- plain text
$reffile pointer
Here are some additional pointers for you:
- Metadata attributes using a
response-prefix in the annotation will be parsed as responses. For example@response-200 { "description" : "User successfully updated", "schema" : "/resources/apidocs/schema.json##user" }would populate the200responses node for the given method ( in this case,PUT /api/v1/users/:id). If the annotation text is not valid JSON or a file pointer, this will be provided as the response description. - Metadata attributes prefixed with
param-will be included as parameters to the method/action. Example:@param-firstname { "type": "string", "required" : "false", "in" : "query" }If the annotation text is not valid JSON or a file pointer, this will be provided as the parameter description and the parameter requirement will be set tofalse. - Parameters provided via the route ( e.g. the
idin/api/v1/users/:id) will always be included in the array of parameters as required for the method. Annotations on those parameters may be used to provide additional documentation. - Security Requirement Objects defined in the cbswagger config will be displayed on every API method, except methods that override the default with
@security. You may use the name of a security scheme, a JSON array of Security Requirement Objects, or a file pointer. Security Requirement Objects must have the same name as a Security Scheme Object defined under components incbswaggersettings. - You may also provide paths to JSON files which describe complex objects which may not be expressed within the attributes themselves. This is ideal to provide an endpoint for parameters and responses If the atttribute ends with
.json, this will be included in the generated OpenAPI document as a $ref include. - Attributes which are not part of the swagger path specification should be prefixed with an
x-, x-attributes are an official part of the OpenAPI Specification and may be used to provide additional information for your developers and consumers hintattributes, provided as either comment@annotations or as function body attributes will be treated as the description for the methoddescriptiondue to variances in parsing comment annotations,descriptionannotations must be provided as attributes of the function body. For example, you would usefunction update( event, rc, prc ) description="Updates a user"{}rather than@description Updates a usertags: A list of tags to include in the operation metadata:@tags Authentication,Authors.
Basic Example:
/**
* Add a new user into the system
*
* @tags Users,Authentication
*/
function add( event, rc, prc )
parameters="~users.add.parameters.json"
responses="~users.add.responses.json"
security="APIKey"
x-SomeAdditionalInfo="Here is some additional information on this path"
{
...[ Your code here ]...
}Example using file pointers:
/**
* @hint Adds a new user
* @x-parameters ~users.add.parameters.json##user
* @responses ~users.add.responses.json
* @x-SomeAdditionalInfo Here is some additional information on this path
*/
function add( event, rc, prc ){
...[ Your code here ]...
}Example using JSON ( + file pointers )
Note: Because CFML has its own parameters key within the function metadata, we would pull in a document of parameters using x-parameters, which will appear as parameters in the swagger method definition
/**
* @summary Adds a new user
* @hint Adds a new user with a longer description.
* @x-parameters ~users.add.parameters.json
* @responses ~users.add.responses.json
* @x-SomeAdditionalInfo Here is some additional information on this path
* @security ~users.add.security.json
* @requestBody {
* "description" : "User to add",
* "required" : true,
* "content" : {
* "application/json" : {
* "schema" : { "$ref" : "/includes/apidocs/NewUser.json" }
* }
* }
* }
*/
function add( event, rc, prc ){
}
/**
* @param-firstname { "schema" : { "type": "string" }, "required" : "false", "in" : "query" }
* @param-lastname { "schema" : { "type": "string" }, "required" : "false", "in" : "query" }
* @param-email { "schema" : { "type": "string" }, "required" : "false", "in" : "query" }
* @security [ { "APIKey": [] } ]
* @response-default { "description" : "User successfully updated", "content" : { "application/json" : { "schema" : { "$ref" : "/resources/apidocs/schema.json##user" } } } }
*/
function update( event, rc, prc ) description="Updates a user"{
}The shortcut notation to expand the path to the samplesPath setting is by using the ~ prefix. However, please note that this prefix only works on the annotations within a component NOT within a json document.
Using convention paths to generate documentation schema and samples
Conventions also exist, which will allow you to place JSON files within a conventions directory, defined by the samplesPath setting, which will automatically be included as part of your documentation. The default samples path is resources/apidocs. A JSON file placed, for example, at the location of resources/apidocs/responses/api.v1.Users.add.201.json, would automatically be picked as the 201 status code response for the add method of the Users handler, within the api.v1 directory.
In addition to the responses sub-directory, the directories of parameters and responseBody will also be inspected for content which matches the route/event being parsed. The latter two directories are parsed as-is, and are assumed to be in a valid Swagger specification format.
File naming conventions supported include:
[handler].[methodName].json- all sample types[moduleName].[handler].[methodName].json- all sample types[handler].[methodName](.[status code]).json- responses with or without status codes[moduleName].[handler].[methodName](.[status code]).json- responses with or without status codes
You can influence the operation Ids by adding a displayName to your handler CFC.
component displayName="API.v1.Users"{
}
Copyright Since 2016 Ortus Solutions, Corp www.ortussolutions.com
Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.
"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God. And not only so, but we glory in tribulations also: knowing that tribulation worketh patience; And patience, experience; and experience, hope: And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the Holy Ghost which is given unto us. ." Romans 5:5
"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12
