schema-api v0.2.3

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

License

(The MIT License)