'use strict' const { test } = require('tap') const Fastify = require('fastify') const Swagger = require('swagger-parser') const fastifySwagger = require('../../../index') const openapiOption = { openapi: {}, refResolver: { buildLocalReference: (json, baseUri, fragment, i) => { return json.$id || `def-${i}` } } } test('support $ref schema', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, openapiOption) fastify.register(async (instance) => { instance.addSchema({ $id: 'Order', type: 'object', properties: { id: { type: 'integer' } } }) instance.post('/', { schema: { body: { $ref: 'Order#' }, response: { 200: { $ref: 'Order#' } } } }, () => {}) }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') t.match(Object.keys(openapiObject.components.schemas), ['Order']) await Swagger.validate(openapiObject) }) test('support $ref relative pointers in params', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, openapiOption) fastify.register(async (instance) => { instance.addSchema({ $id: 'Order', type: 'object', properties: { OrderId: { type: 'object', properties: { id: { type: 'string' } } } } }) instance.get('/:id', { schema: { params: { $ref: 'Order#/properties/OrderId' }, response: { 200: { $ref: 'Order#' } } } }, () => {}) }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') t.match(Object.keys(openapiObject.components.schemas), ['Order']) await Swagger.validate(openapiObject) }) test('support nested $ref schema : simple test', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, openapiOption) fastify.register(async (instance) => { instance.addSchema({ $id: 'OrderItem', type: 'object', properties: { id: { type: 'integer' } } }) instance.addSchema({ $id: 'ProductItem', type: 'object', properties: { id: { type: 'integer' } } }) instance.addSchema({ $id: 'Order', type: 'object', properties: { products: { type: 'array', items: { $ref: 'OrderItem' } } } }) instance.post('/', { schema: { body: { $ref: 'Order' }, response: { 200: { $ref: 'Order' } } } }, () => {}) instance.post('/other', { schema: { body: { $ref: 'ProductItem' } } }, () => {}) }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') const schemas = openapiObject.components.schemas t.match(Object.keys(schemas), ['OrderItem', 'ProductItem', 'Order']) // ref must be prefixed by '#/components/schemas/' t.equal(schemas.Order.properties.products.items.$ref, '#/components/schemas/OrderItem') await Swagger.validate(openapiObject) }) test('support nested $ref schema : complex case', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, openapiOption) fastify.register(async (instance) => { instance.addSchema({ $id: 'schemaA', type: 'object', properties: { id: { type: 'integer' } } }) instance.addSchema({ $id: 'schemaB', type: 'object', properties: { id: { type: 'string' } } }) instance.addSchema({ $id: 'schemaC', type: 'object', properties: { a: { type: 'array', items: { $ref: 'schemaA' } } } }) instance.addSchema({ $id: 'schemaD', type: 'object', properties: { b: { $ref: 'schemaB' }, c: { $ref: 'schemaC' } } }) instance.post('/url1', { schema: { body: { $ref: 'schemaD' }, response: { 200: { $ref: 'schemaB' } } } }, () => {}) instance.post('/url2', { schema: { body: { $ref: 'schemaC' }, response: { 200: { $ref: 'schemaA' } } } }, () => {}) }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') const schemas = openapiObject.components.schemas t.match(Object.keys(schemas), ['schemaA', 'schemaB', 'schemaC', 'schemaD']) // ref must be prefixed by '#/components/schemas/' t.equal(schemas.schemaC.properties.a.items.$ref, '#/components/schemas/schemaA') t.equal(schemas.schemaD.properties.b.$ref, '#/components/schemas/schemaB') t.equal(schemas.schemaD.properties.c.$ref, '#/components/schemas/schemaC') await Swagger.validate(openapiObject) }) test('support $ref in response schema', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, openapiOption) fastify.register(function (instance, _, done) { instance.addSchema({ $id: 'order', type: 'string', enum: ['foo'] }) instance.post('/', { schema: { response: { 200: { type: 'object', properties: { order: { $ref: 'order' } } } } } }, () => {}) done() }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') await Swagger.validate(openapiObject) }) test('support $ref for enums in other schemas', async (t) => { const fastify = Fastify() const enumSchema = { $id: 'order', anyOf: [{ type: 'string', const: 'foo' }, { type: 'string', const: 'bar' }] } const enumRef = { $ref: 'order' } const objectWithEnumSchema = { $id: 'object', type: 'object', properties: { type: enumRef }, required: ['type'] } await fastify.register(fastifySwagger, openapiOption) await fastify.register(async (instance) => { instance.addSchema(enumSchema) instance.addSchema(objectWithEnumSchema) instance.post('/', { schema: { body: { type: 'object', properties: { order: { $ref: 'order' } } } } }, async () => ({ result: 'OK' })) }) await fastify.ready() const responseBeforeSwagger = await fastify.inject({ method: 'POST', url: '/', payload: { order: 'foo' } }) t.equal(responseBeforeSwagger.statusCode, 200) const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') await Swagger.validate(openapiObject) const responseAfterSwagger = await fastify.inject({ method: 'POST', url: '/', payload: { order: 'foo' } }) t.equal(responseAfterSwagger.statusCode, 200) }) test('support nested $ref schema : complex case without modifying buildLocalReference', async (t) => { const fastify = Fastify() fastify.register(fastifySwagger, { openapi: {} }) fastify.register(async (instance) => { instance.addSchema({ $id: 'schemaA', type: 'object', properties: { id: { type: 'integer' } } }) instance.addSchema({ $id: 'schemaB', type: 'object', properties: { id: { type: 'string' } } }) instance.addSchema({ $id: 'schemaC', type: 'object', properties: { a: { type: 'array', items: { $ref: 'schemaA' } } } }) instance.addSchema({ $id: 'schemaD', type: 'object', properties: { b: { $ref: 'schemaB' }, c: { $ref: 'schemaC' } } }) instance.post('/url1', { schema: { body: { $ref: 'schemaD' }, response: { 200: { $ref: 'schemaB' } } } }, () => {}) instance.post('/url2', { schema: { body: { $ref: 'schemaC' }, response: { 200: { $ref: 'schemaA' } } } }, () => {}) }) await fastify.ready() const openapiObject = fastify.swagger() t.equal(typeof openapiObject, 'object') const schemas = openapiObject.components.schemas t.match(Object.keys(schemas), ['def-0', 'def-1', 'def-2', 'def-3']) // ref must be prefixed by '#/components/schemas/' t.equal(schemas['def-2'].properties.a.items.$ref, '#/components/schemas/def-0') t.equal(schemas['def-3'].properties.b.$ref, '#/components/schemas/def-1') t.equal(schemas['def-3'].properties.c.$ref, '#/components/schemas/def-2') await Swagger.validate(openapiObject) })