Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature swagger auto generate option #43

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature swagger auto generate option #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f48f31
create option to disable Swagger documentation on defaults methods.
thiagoarioli Sep 3, 2017
39a5ae7
Update readme documentation with swagger options.
thiagoarioli Sep 3, 2017
b5270b5
fixed association object use.
thiagoarioli Sep 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,39 @@ Swagger documentation is automatically generated for all endpoints and can be vi
at the server URL. By default this will be [http://localhost:8124/](http://localhost:8124/). The swagger docs provide quick
access to testing your endpoints along with model schema descriptions and query options.

You can prevent Swagger documentation on CRUD endpoints by setting the correct property to ``false`` within the ``routeOptions`` object. Below is a list of properties and their effect:

Property | Effect when false
--- | ---
enableReadSwagger | omits ``GET /path`` and ``GET /path/{_id}`` endpoints
enableCreateSwagger | omits ``POST /path`` endpoint
enableUpdateSwagger | omits ``PUT /path/{_id}`` endpoint
enableDeleteSwagger | omits ``DELETE /path`` and ``DELETE /path/{_id}`` endpoints

Similarly, you can prevent association endpoints from generating through the following properties within each association object:

Property | Effect when false
--- | ---
enableAddSwagger | omits ``POST /owner/{ownerId}/child`` and ``PUT /owner/{ownerId}/child/{childId}`` endpoints
enableRemoveSwagger | omits ``DELETE /owner/{ownerId}/child`` and ``ELETE /owner/{ownerId}/child/{childId}`` endpoints
enableReadSwagger | omits ``GET /owner/{ownerId}/child`` endpoint

For example, a routeOption object that omits endpoints for creating objects and removing a specific association could look like this:

```javascript
routeOptions: {
enableReadSwagger: false,
associations: {
users: {
type: "MANY_ONE",
alias: "user",
model: "user",
enableReadSwagger: false
}
}
}
```

[Back to top](#readme-contents)

## Creating endpoints
Expand Down
11 changes: 9 additions & 2 deletions tests/rest-helper-factory.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,11 @@ test('rest-helper-factory.generateRoutes', function (t) {
allowRead: false,
allowCreate: false,
allowUpdate: false,
allowDelete: false
allowDelete: false,
enableReadSwagger: false,
enableCreateSwagger: false,
enableUpdateSwagger: false,
enableDeleteSwagger: false
}
};
var userModel = mongoose.model("user", userSchema);
Expand Down Expand Up @@ -340,7 +344,10 @@ test('rest-helper-factory.generateRoutes', function (t) {
type: "MANY_MANY",
allowAdd: false,
allowRemove: false,
allowRead: false
allowRead: false,
enableAddSwagger: false,
enableRemoveSwagger: false,
enableReadSwagger: false
}
}
}
Expand Down
85 changes: 70 additions & 15 deletions utilities/rest-helper-factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,10 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (model.routeOptions.enableReadSwagger !== false) {
tags = ['api', collectionName];
}

server.route({
method: 'GET',
Expand All @@ -208,7 +212,7 @@ module.exports = function (logger, mongoose, server) {
handler: handler,
auth: auth,
description: 'Get a list of ' + collectionName + 's',
tags: ['api', collectionName],
tags: tags,
cors: config.cors,
validate: {
query: config.enableQueryValidation ? queryValidation : Joi.any(),
Expand Down Expand Up @@ -299,14 +303,19 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (model.routeOptions.enableReadSwagger !== false) {
tags = ['api', collectionName];
}

server.route({
method: 'GET',
path: '/' + resourceAliasForRoute + '/{_id}',
config: {
handler: handler,
auth: auth,
description: 'Get a specific ' + collectionName,
tags: ['api', collectionName],
tags: tags,
cors: config.cors,
validate: {
query: config.enableQueryValidation ? queryValidation : Joi.any(),
Expand Down Expand Up @@ -391,6 +400,11 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (model.routeOptions.enableCreateSwagger !== false) {
tags = ['api', collectionName];
}

server.route({
method: 'POST',
path: '/' + resourceAliasForRoute,
Expand All @@ -399,7 +413,7 @@ module.exports = function (logger, mongoose, server) {
auth: auth,
cors: config.cors,
description: 'Create one or more new ' + collectionName + 's',
tags: ['api', collectionName],
tags: tags,
validate: {
payload: config.enablePayloadValidation ? createModel : Joi.any(),
headers: headersValidation
Expand Down Expand Up @@ -475,15 +489,20 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

server.route({
let tags = [];
if (model.routeOptions.enableDeleteSwagger !== false) {
tags = ['api', collectionName];
}

server.route({
method: 'DELETE',
path: '/' + resourceAliasForRoute + "/{_id}",
config: {
handler: handler,
auth: auth,
cors: config.cors,
description: 'Delete a ' + collectionName,
tags: ['api', collectionName],
tags: tags,
validate: {
params: {
_id: Joi.objectId().required()
Expand Down Expand Up @@ -568,15 +587,20 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

server.route({
let tags = [];
if (model.routeOptions.enableDeleteSwagger !== false) {
tags = ['api', collectionName];
}

server.route({
method: 'DELETE',
path: '/' + resourceAliasForRoute,
config: {
handler: handler,
auth: auth,
cors: config.cors,
description: 'Delete multiple ' + collectionName + 's',
tags: ['api', collectionName],
tags: tags,
validate: {
payload: config.enablePayloadValidation ? payloadModel : Joi.any(),
headers: headersValidation
Expand Down Expand Up @@ -653,15 +677,21 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

server.route({
let tags = [];
if (model.routeOptions.enableUpdateSwagger !== false) {
tags = ['api', collectionName];
}


server.route({
method: 'PUT',
path: '/' + resourceAliasForRoute + '/{_id}',
config: {
handler: handler,
auth: auth,
cors: config.cors,
description: 'Update a ' + collectionName,
tags: ['api', collectionName],
tags: tags,
validate: {
params: {
_id: Joi.objectId().required()
Expand Down Expand Up @@ -748,15 +778,20 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

server.route({
let tags = [];
if (association.enableAddSwagger !== false) {
tags = ['api', associationName, ownerModelName];
}

server.route({
method: 'PUT',
path: '/' + ownerAlias + '/{ownerId}/' + childAlias + "/{childId}",
config: {
handler: handler,
auth: auth,
cors: config.cors,
description: 'Add a single ' + childModelName + ' to a ' + ownerModelName + '\'s list of ' + associationName,
tags: ['api', associationName, ownerModelName],
tags: tags,
validate: {
params: {
ownerId: Joi.objectId().required(),
Expand Down Expand Up @@ -835,6 +870,11 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (association.enableRemoveSwagger !== false) {
tags = ['api', associationName, ownerModelName];
}

server.route({
method: 'DELETE',
path: '/' + ownerAlias + '/{ownerId}/' + childAlias + "/{childId}",
Expand All @@ -843,7 +883,7 @@ module.exports = function (logger, mongoose, server) {
auth: auth,
cors: config.cors,
description: 'Remove a single ' + childModelName + ' from a ' + ownerModelName + '\'s list of ' + associationName,
tags: ['api', associationName, ownerModelName],
tags: tags,
validate: {
params: {
ownerId: Joi.objectId().required(),
Expand Down Expand Up @@ -932,6 +972,11 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (association.enableAddSwagger !== false) {
tags = ['api', associationName, ownerModelName];
}

server.route({
method: 'POST',
path: '/' + ownerAlias + '/{ownerId}/' + childAlias,
Expand All @@ -940,7 +985,7 @@ module.exports = function (logger, mongoose, server) {
auth: auth,
cors: config.cors,
description: 'Add multiple ' + childModelName + 's to a ' + ownerModelName + '\'s list of ' + associationName,
tags: ['api', associationName, ownerModelName],
tags: tags,
validate: {
params: {
ownerId: Joi.objectId().required()
Expand Down Expand Up @@ -1017,6 +1062,11 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (association.enableRemoveSwagger !== false) {
tags = ['api', associationName, ownerModelName];
}

server.route({
method: 'DELETE',
path: '/' + ownerAlias + '/{ownerId}/' + childAlias,
Expand All @@ -1025,7 +1075,7 @@ module.exports = function (logger, mongoose, server) {
auth: auth,
cors: config.cors,
description: 'Remove multiple ' + childModelName + 's from a ' + ownerModelName + '\'s list of ' + associationName,
tags: ['api', associationName, ownerModelName],
tags: tags,
validate: {
params: {
ownerId: Joi.objectId().required()
Expand Down Expand Up @@ -1155,6 +1205,11 @@ module.exports = function (logger, mongoose, server) {
headersValidation = null;
}

let tags = [];
if (association.enableReadSwagger !== false) {
tags = ['api', associationName, ownerModelName];
}

server.route({
method: 'GET',
path: '/' + ownerAlias + '/{ownerId}/' + childAlias,
Expand All @@ -1163,7 +1218,7 @@ module.exports = function (logger, mongoose, server) {
auth: auth,
cors: config.cors,
description: 'Get all of the ' + associationName + ' for a ' + ownerModelName,
tags: ['api', associationName, ownerModelName],
tags: tags,
validate: {
query: config.enableQueryValidation ? queryValidation : Joi.any(),
params: {
Expand Down