{"repo":"epiphone/routing-controllers-openapi","free":true,"listed":false,"github":"https://github.com/epiphone/routing-controllers-openapi","clone":"git clone https://github.com/epiphone/routing-controllers-openapi.git","description":"Runtime OpenAPI v3 schema generation for routing-controllers.","language":"TypeScript","stars":316,"topics":["routing-controllers","openapi","openapi3","swagger-generator","api-documentation-tool","expressjs","koajs"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"routing-controllers-openapi Runtime OpenAPI v3 schema generation for routing-controllers. Installation npm install --save routing-controllers-openapi Usage prints out the following specification: Check /sample for a complete sample application. Configuration routingControllersToSpec has the following type signature: routingControllerOptions refers to the options object used to configure routing-controllers. Pass in the same options here to have your routePrefix and defaults options reflected in the resulting OpenAPI spec. additionalProperties is a partial OpenAPI object that gets merged into the result spec. You can for example set your own info or components keywords here. Validation classes Use class-validator-jsonschema to convert your validation classes into OpenAPI-compatible schemas: Decorating with additional keywords Use the @OpenAPI decorator to supply your actions with additional keywords: The parameter object consists of any number of properties from the Operation object. These properties are then merged into the spec, overwriting any existing values. Alternatively you can call @OpenAPI with a function of type (source: OperationObject, route: IRoute) = OperationObject , i.e. a function receiving the existing spec as well as the target route, spitting out an updated spec. This function parameter can be used to implement for example your own merging logic or custom decorators. Multiple @OpenAPI decorators A single handler can be decorated with multiple @OpenAPI s. No","default_branch":null,"files":null,"tree":[],"storefront":"/r/epiphone","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/epiphone/routing-controllers-openapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}