![]() summary: a short description of the method.The documentation section of the event configuration can contain the following attributes: To define the documentation for a given function event, you need to create a documentation attribute for your http event in your serverless.yml file. The custom section of your serverless.yml can be configured as below: custom: documentation: version: '1' title: 'My API' description: 'This is my API' models: - name: "PutDocumentRequest" description: "PUT Document request model (inline example)" contentType: "application/json" schema: $schema: "" properties: SomeObject: type: "object" properties: SomeAttribute: type: "string" Functions This plugin is compatible with the same documentation configuration structure in serverless-aws-documentation and can run beside it. ![]() ![]() To configure this plugin to generate valid OpenAPI documentation there are two places you'll need to modify in your serverless.yml file, the custom variables section and the http event section for each given function in your service. Options Plugin: ServerlessOpenAPIDocumentation This plugin requires additional configuration to use, see the " Configuration" section for how to configure the plugin to generate documentation.īelow are the commandline options to run the generator: serverless openapi generate Works well with Lincoln OpenAPI Renderer. ![]() The configuration is inspired by the format used in serverless-aws-documentation. Generates OpenAPI 3.0.0 documentation from serverless configuration files. ![]()
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |