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

Feature/add examples responses parameters and apidoc configuration #38

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

Feature/add examples responses parameters and apidoc configuration #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19c116a
Add host, basePath and schemes to the output file and make them confi…
Nov 29, 2018
3f35e85
Add request examples, responses and refactor the parameters management
Nov 29, 2018
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
132 changes: 90 additions & 42 deletions lib/apidocToSwagger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,42 @@ function createPostPushPutOutput(verbs, definitions, pathKeys) {
});

params = params.concat(pathParams);
var required = verbs.parameter && verbs.parameter.fields &&
var required = verbs.parameter && verbs.parameter.fields &&
verbs.parameter.fields.Parameter && verbs.parameter.fields.Parameter.length > 0;
var examples = _.get(verbs, 'parameter.examples');

params.push({
if (examples) {
var requestExample = _.find(examples, {title: 'Request-Example:'});

if (requestExample) {
var description = requestExample.content;
}
}

if (verbDefinitionResult.topLevelParametersRef !== null) {
params.push({
"in": "body",
"name": "body",
"description": removeTags(verbs.description),
"description": typeof description === 'undefined' ? removeTags(verbs.description) : description,
"required": required,
"schema": {
"$ref": "#/definitions/" + verbDefinitionResult.topLevelParametersRef
}
});

}

var responses = {};

if (_.has(verbs, 'success.examples[0]')) {
var successExamples = _.get(verbs, 'success.examples');

successExamples.forEach(successExample => {
responses[successExample.title] = {
"description": successExample.content
};
})
}

pathItemObject[verbs.type] = {
tags: [verbs.group],
summary: removeTags(verbs.description),
Expand All @@ -102,23 +125,24 @@ function createPostPushPutOutput(verbs, definitions, pathKeys) {
produces: [
"application/json"
],
parameters: params
parameters: params,
responses: responses
}

if (verbDefinitionResult.topLevelSuccessRef) {
pathItemObject[verbs.type].responses = {
"200": {
"description": "successful operation",
"schema": {
"type": verbDefinitionResult.topLevelSuccessRefType,
"items": {
"$ref": "#/definitions/" + verbDefinitionResult.topLevelSuccessRef
}
}
}
};
"200": {
"description": "successful operation",
"schema": {
"type": verbDefinitionResult.topLevelSuccessRefType,
"items": {
"$ref": "#/definitions/" + verbDefinitionResult.topLevelSuccessRef
}
}
}
};
};

return pathItemObject;
}

Expand All @@ -132,12 +156,12 @@ function createVerbDefinitions(verbs, definitions) {

var fieldArrayResult = {};
if (verbs && verbs.parameter && verbs.parameter.fields) {
fieldArrayResult = createFieldArrayDefinitions(verbs.parameter.fields.Parameter, definitions, verbs.name, defaultObjectName);
fieldArrayResult = createFieldArrayDefinitions(verbs.parameter.fields.Parameter, definitions, verbs.name, defaultObjectName);
result.topLevelParametersRef = fieldArrayResult.topLevelRef;
};

if (verbs && verbs.success && verbs.success.fields) {
fieldArrayResult = createFieldArrayDefinitions(verbs.success.fields["Success 200"], definitions, verbs.name, defaultObjectName);
fieldArrayResult = createFieldArrayDefinitions(verbs.success.fields["Success 200"], definitions, verbs.name, defaultObjectName);
result.topLevelSuccessRef = fieldArrayResult.topLevelRef;
result.topLevelSuccessRefType = fieldArrayResult.topLevelRefType;
};
Expand Down Expand Up @@ -171,7 +195,7 @@ function createFieldArrayDefinitions(fieldArray, definitions, topLevelRef, defau
nestedName.propertyName = null;
} else if (parameter.type == "Array") {
objectName = nestedName.propertyName;
nestedName.propertyName = null;
nestedName.propertyName = null;
result.topLevelRefType = "array";
}
result.topLevelRef = objectName;
Expand Down Expand Up @@ -235,6 +259,19 @@ function createGetDeleteOutput(verbs,definitions) {
verbs.type = verbs.type === "del" ? "delete" : verbs.type;

var verbDefinitionResult = createVerbDefinitions(verbs,definitions);

var responses = {};

if (_.has(verbs, 'success.examples[0]')) {
var successExamples = _.get(verbs, 'success.examples');

successExamples.forEach(successExample => {
responses[successExample.title] = {
"description": successExample.content
};
})
}

pathItemObject[verbs.type] = {
tags: [verbs.group],
summary: removeTags(verbs.description),
Expand All @@ -244,20 +281,21 @@ function createGetDeleteOutput(verbs,definitions) {
produces: [
"application/json"
],
parameters: createPathParameters(verbs)
parameters: createPathParameters(verbs),
responses: responses
}
if (verbDefinitionResult.topLevelSuccessRef) {
pathItemObject[verbs.type].responses = {
"200": {
"description": "successful operation",
"schema": {
"type": verbDefinitionResult.topLevelSuccessRefType,
"items": {
"$ref": "#/definitions/" + verbDefinitionResult.topLevelSuccessRef
}
}
}
};
"200": {
"description": "successful operation",
"schema": {
"type": verbDefinitionResult.topLevelSuccessRefType,
"items": {
"$ref": "#/definitions/" + verbDefinitionResult.topLevelSuccessRef
}
}
}
};
};
return pathItemObject;
}
Expand All @@ -271,22 +309,32 @@ function createPathParameters(verbs, pathKeys) {
pathKeys = pathKeys || [];

var pathItemObject = [];
if (verbs.parameter && verbs.parameter.fields.Parameter) {

for (var i = 0; i < verbs.parameter.fields.Parameter.length; i++) {
var param = verbs.parameter.fields.Parameter[i];
var field = param.field;
var type = param.type;
pathItemObject.push({
name: field,
in: type === "file" ? "formData" : "path",
required: !param.optional,
type: param.type.toLowerCase(),
description: removeTags(param.description)
});
if (!_.has(verbs, 'parameter.fields')) {
return pathItemObject;
}

var parametersTypes = _.get(verbs, 'parameter.fields');

for (var parameterType in parametersTypes) {
if (
!parametersTypes.hasOwnProperty(parameterType)
|| ['Path parameters', 'Query parameters'].indexOf(parameterType) === -1
) {
continue;
}

parametersTypes[parameterType].forEach(parameter => {
pathItemObject.push({
name: parameter.field,
in: parameterType === "Path parameters" ? "path" : "query",
required: !parameter.optional,
type: parameter.type.toLowerCase(),
description: removeTags(parameter.description)
});
});
}

return pathItemObject;
}

Expand Down
13 changes: 11 additions & 2 deletions lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ function createApidocSwagger(options) {
});
apidoc.setLogger(app.log);
apidoc.setMarkdownParser(app.markdown);
apidoc.setPackageInfos(packageInfo.get());

var packageInfos = packageInfo.get();

apidoc.setPackageInfos(packageInfos);

api = apidoc.parse(app.options);

Expand All @@ -104,7 +107,13 @@ function createApidocSwagger(options) {
if (app.options.parse !== true){
var apidocData = JSON.parse(api.data);
var projectData = JSON.parse(api.project);
api["swaggerData"] = JSON.stringify(apidocSwagger.toSwagger(apidocData , projectData));
var swaggerData = apidocSwagger.toSwagger(apidocData , projectData);

swaggerData.host = packageInfos.host || '{{url}}';
swaggerData.basePath = packageInfos.basePath || '';
swaggerData.schemes = packageInfos.schemes || ['http'];

api["swaggerData"] = JSON.stringify(swaggerData);
createOutputFile(api);
}

Expand Down