Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

PhilCorcoran/schema-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

20 Commits

Repository files navigation

schema-api

Serves up a JSON definition of a REST API. Enables self documenting services. Validates data against a JSON schema using tv4

Examples

var schemaAPI = require('schema-api')({
 nickname: 'PetService',
 validation: true
});
var app=express();
//validate the data returned from the database against the 'Cat' model using tv4
app.get('/cat.json', loadDatafromDB(), schemaAPI.validate('Cat'),handleErr);

The API schema will be served at /schema and /schema/PetService. The second url means that the Swagger-UI will display the nickname clearly.(https://github.com/wordnik/swagger-ui) This is useful if you are developing a set of micro services which may be deployed on different servers and domains. Each service can serve up a definition of its own API and this will work cross-domain. In production the API schema is not served and the Access-Control-Allow-Origin header is not set.

Options

nickname the name of the service shown by Swagger-UI and the also the final part of the url.
schema the path to the schema which defaults to apiSchema.json in the same directory as the main module.
validation indicates that you will use tv4 JSON validation. The models will be loaded from your schema file at startup.

Release History

Version Date Description
v0.2.2 2014年09月04日 Debug logging
v0.2.0 2014年08月22日 TV4 JSON validation
v0.1.2 2014年05月07日 Add Options request for Swagger UI in CORS situation
v0.1.1 2014年04月30日 Access-Control-Allow-Headers
v0.1.0 2014年04月29日 Initial Version

License

(The MIT License)

About

Serves up a JSON definition of the API. Enables self documenting services.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors

AltStyle によって変換されたページ (->オリジナル) /