'use strict' const { test } = require('tap') const Fastify = require('fastify') const Swagger = require('swagger-parser') const fastifySwagger = require('../../../index') const S = require('fluent-json-schema') test('support file in json schema', async t => { const opts7 = { schema: { consumes: ['application/x-www-form-urlencoded'], body: { type: 'object', properties: { hello: { description: 'hello', type: 'string', contentEncoding: 'binary' } }, required: ['hello'] } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opts7, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.ok(definedPath) t.same(definedPath.parameters, [{ in: 'formData', name: 'hello', description: 'hello', required: true, type: 'file' }]) }) test('support response description', async t => { const opts8 = { schema: { response: { 200: { description: 'Response OK!', type: 'object' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opts8, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].description, 'Response OK!') }) test('response default description', async t => { const opts9 = { schema: { response: { 200: { type: 'object' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opts9, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].description, 'Default Response') }) test('response 2xx', async t => { const opt = { schema: { response: { '2xx': { type: 'object' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].description, 'Default Response') t.notOk(definedPath.responses['2XX']) }) test('response conflict 2xx and 200', async t => { const opt = { schema: { response: { '2xx': { type: 'object', description: '2xx' }, 200: { type: 'object', description: '200' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].description, '200') t.notOk(definedPath.responses['2XX']) }) test('support status code 204', async t => { const opt = { schema: { response: { 204: { type: 'null', description: 'No Content' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['204'].description, 'No Content') t.notOk(definedPath.responses['204'].schema) }) test('support empty response body for different status than 204', async t => { const opt = { schema: { response: { 204: { type: 'null', description: 'No Content' }, 503: { type: 'null', description: 'Service Unavailable' } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['204'].description, 'No Content') t.notOk(definedPath.responses['204'].content) t.notOk(definedPath.responses['503'].type) t.same(definedPath.responses['503'].description, 'Service Unavailable') t.notOk(definedPath.responses['503'].content) t.notOk(definedPath.responses['503'].type) }) test('support response headers', async t => { const opt = { schema: { response: { 200: { type: 'object', properties: { hello: { type: 'string' } }, headers: { 'X-WORLD': { type: 'string' } } } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].headers, opt.schema.response['200'].headers) t.notOk(definedPath.responses['200'].schema.headers) }) test('response: description and x-response-description', async () => { const description = 'description - always that of response body, sometimes also that of response as a whole' const responseDescription = 'description only for the response as a whole' test('description without x-response-description doubles as response description', async t => { // Given a /description endpoint with only a |description| field in its response schema const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/description', { schema: { response: { 200: { description, type: 'string' } } } }, () => {}) await fastify.ready() // When the Swagger schema is generated const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) // Then the /description endpoint uses the |description| as both the description of the Response Object as well as of its Schema Object const responseObject = api.paths['/description'].get.responses['200'] t.ok(responseObject) t.equal(responseObject.description, description) t.equal(responseObject.schema.description, description) }) test('description alongside x-response-description only describes response body', async t => { // Given a /responseDescription endpoint that also has a |'x-response-description'| field in its response schema const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/responseDescription', { schema: { response: { 200: { 'x-response-description': responseDescription, description, type: 'string' } } } }, () => {}) await fastify.ready() // When the Swagger schema is generated const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) // Then the /responseDescription endpoint uses the |responseDescription| only for the Response Object and the |description| only for the Schema Object const responseObject = api.paths['/responseDescription'].get.responses['200'] t.ok(responseObject) t.equal(responseObject.description, responseDescription) t.equal(responseObject.schema.description, description) t.equal(responseObject.schema.responseDescription, undefined) }) }) test('support "default" parameter', async t => { const opt = { schema: { response: { 200: { description: 'Expected Response', type: 'object', properties: { foo: { type: 'string' } } }, default: { description: 'Default Response', type: 'object', properties: { bar: { type: 'string' } } } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses.default, { description: 'Default Response', schema: { description: 'Default Response', type: 'object', properties: { bar: { type: 'string' } } } }) }) test('fluent-json-schema', async t => { const opt = { schema: { response: { 200: S.object() } } } const fastify = Fastify() fastify.register(fastifySwagger, { swagger: true, routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.responses['200'].description, 'Default Response') }) test('support "patternProperties" in json schema', async t => { const opt = { schema: { body: { type: 'object', patternProperties: { '^[a-z]{2,3}-[a-zA-Z]{2}$': { type: 'string' } } }, response: { 200: { description: 'Expected Response', type: 'object', properties: { foo: { type: 'object', patternProperties: { '^[a-z]{2,3}-[a-zA-Z]{2}$': { type: 'string' } }, additionalProperties: false } } } } } } const fastify = Fastify() fastify.register(fastifySwagger, { swagger: true, routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.parameters[0].schema, { type: 'object', additionalProperties: { type: 'string' } }) t.same(definedPath.responses[200], { description: 'Expected Response', schema: { description: 'Expected Response', type: 'object', properties: { foo: { type: 'object', additionalProperties: { type: 'string' } } } } }) }) test('support "const" keyword', async t => { const opt = { schema: { body: { type: 'object', properties: { obj: { type: 'object', properties: { constantProp: { const: 'my-const' } } } } } } } const fastify = Fastify() fastify.register(fastifySwagger, { routePrefix: '/docs', exposeRoute: true }) fastify.get('/', opt, () => {}) await fastify.ready() const swaggerObject = fastify.swagger() const api = await Swagger.validate(swaggerObject) const definedPath = api.paths['/'].get t.same(definedPath.parameters[0].schema, { type: 'object', properties: { obj: { type: 'object', properties: { constantProp: { enum: ['my-const'] } } } } }) })