hyped-swagger-middleware
v1.1.0
Published
Middleware component that hooks into hyped and uses its resources to generate a swagger schema file
Downloads
5
Readme
hyped-swagger-middleware
Autohost + Hyped middleware that can be wired up to an endpoint that will return a Swagger API doc spec file.
Warning: This example might be a little rough if you are starting from scratch. This is primarily to show how to integrate with an existing hyped + autohost solution.
Installation
npm install hyped-swagger-middleware --save
Usage
// index.js
var apiMetadata = {
apiRoot: "/",
version: "1.0.0",
title: "Hyped API",
description: "Our api",
tos: "http://example.com/terms_of_service",
contact: {
name: "John Doe",
email: "[email protected]",
url: "http://example.com"
},
license: {
name: "Commercial",
url: "http://example.com/license"
}
};
var autohost = require( "autohost" );
var hyped = require( "hyped" )( true, true );
var swaggerMiddleware = require( "hyped-swagger-middleware" );
var host = hyped.createHost( autohost, {
// regular autohost configuration goes here
},
function() {
host.http.middleware(
"/api/swagger/:version/swagger.json",
swaggerMiddleware( apiMetadata, hyped )
);
host.start();
}
);
Example
Look at the example
directory to see an example implementation. To run the example:
npm install
npm run example
Then in a new window:
curl http://localhost:8800/api/swagger/1/swagger.json