JSON Schema validation for angular resource.
npm install angular-validated-resource
Designed to be an (almost) drop-in replacement for angular resource. When you configure the resource actions, additionally pass a schema to queryParamsSchema
, requestBodySchema
, or responseBodySchema
to automatically validate on every request.
angular.module 'Product', [
require 'angular-validated-resource'
]
.factory 'Product', ngInject (validatedResource) ->
validatedResource 'http://api.test.com/products/:_id', {_id: '@_id'},
query:
method: 'GET'
isArray: true
queryParamsSchema: require './product_schemas/query/query_params.json'
requestBodySchema: require './product_schemas/query/request_body.json'
responseBodySchema: require './product_schemas/query/response_body.json'
move:
method: 'POST'
url: 'http://api.test.com/products/:_id/move'
queryParamsSchema: require './product_schemas/move/query_params.json'
requestBodySchema: require './product_schemas/move/request_body.json'
responseBodySchema: require './product_schemas/move/response_body.json'
If window.env is 'test', validation will not allow unknown fields. Otherwise, validation will allow unknown fields.
Although not required, we strongly recommended that you validate all parts of the request (queryParams, requestBody, and responseBody) for every action, even if the validation is just checking for an empty object. This way, you will catch any unexpected data that you pass through.
Please follow our Code of Conduct when contributing to this project.
$ git clone https://github.com/goodeggs/angular-validated-resource && cd angular-validated-resource
$ npm install
$ npm test
Module scaffold generated by generator-goodeggs-npm.