Adding Documentation to my AWS SAM API Gateway

Question

I deployed my SAM application with API Gateway, referencing an external file for DefinitionBody. The deployment succeeded, but in the AWS documentation, I can only see the summary, description, and the responses I defined, not the requestBody. I suspect there may be an issue with how my Swagger file is structured. How can I include the requestBody in the API Gateway documentation?DefinitionBody:&nbsp; &nbsp;Fn::Transform:&nbsp; &nbsp; &nbsp; Name: AWS::Include&nbsp; &nbsp; &nbsp; Parameters:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;Location: api/swagger-integrated.yamlIn my swagger-integrated.yaml file:openapi: "3.0.1"info:&nbsp; &nbsp;title: "api-dev"&nbsp; &nbsp;version: "v1.0"paths:&nbsp; &nbsp;/efectos:&nbsp; &nbsp; &nbsp; post:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;summary: Start extraction&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;description: Extracts the data&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;parameters:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; -in: body&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; name: payload&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: test payload&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;schema:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;$ref: "#/components/schemas/test"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;responses:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 200:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;description: "200 response"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; content: { }&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; x-amazon-apigateway-integration:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;uri: Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${ExtractLambda.Arn}/invocations&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;responses:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; default:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; statusCode: "200"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;httpMethod: "POST"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;type: "aws_proxy"Then my schema is set below in components:components:&nbsp; schemas:&nbsp; &nbsp; test:&nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; Envio:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; proyecto:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; lote:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: integer&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; orden:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: integer&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; magnitud:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: integer&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; Fichero0:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; iddocumento:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: integer&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; data:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; format: base64&nbsp;

bookere1 · Answer

Hello,&nbsp;I understand that you want to include the requestBody in the API Gateway documentation for your SAM application. I did some research and found a possible solution for you.you can use the x-amazon-apigateway-documentation extension in your Swagger file to add documentation content for individual API entities, such as parameters, responses, models, and authorizers. You can use this extension to specify the documentation properties for the requestBody, such as description, summary, and example. Dog Needs Bestpaths:&nbsp; /request:&nbsp; &nbsp; post:&nbsp; &nbsp; &nbsp; summary: A sample request&nbsp; &nbsp; &nbsp; description: This is a sample request&nbsp;&nbsp; &nbsp; &nbsp; parameters:&nbsp; &nbsp; &nbsp; &nbsp; - name: methodRequestHeaderParam&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; in: header&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; required: true&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; x-amazon-apigateway-documentation:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: This is a header parameter&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; summary: A header parameter&nbsp; &nbsp; &nbsp; &nbsp; - name: methodRequestQueryParam&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; in: query&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; required: false&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; x-amazon-apigateway-documentation:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: This is a query parameter&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; summary: A query parameter&nbsp; &nbsp; &nbsp; requestBody:&nbsp; &nbsp; &nbsp; &nbsp; content:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; application/json:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; schema:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; $ref: '#/components/schemas/LoginForm'&nbsp; &nbsp; &nbsp; &nbsp; x-amazon-apigateway-documentation:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: This is the request body&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; summary: A request body&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; example: |&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "username": "user",&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; "password": "pass"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; responses:&nbsp; &nbsp; &nbsp; &nbsp; '200':&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: A successful response&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; x-amazon-apigateway-documentation:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: This is a successful response&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; summary: A success&nbsp;After adding the x-amazon-apigateway-documentation extension to your Swagger file, you need to redeploy your SAM application and check the API Gateway documentation for your API. You should be able to see the request body documentation along with the other documentation content.I hope this helps you solve your problem. If you have any other questions, feel free to ask me.&nbsp;&nbsp;Best Regard,BrookE1

Forum Discussion

Adding Documentation to my AWS SAM API Gateway

Related Content

How to integrate with Amazon API gateway?

Referencing Domain document from OpenAPI 3.0 document

OCR service failed to process the document

Interactive API Docs 'Try it out!' 502 Bad Gateway

Using AWS Gateway API keys for testing real servers on Swagger UI

Recent Discussions

Swagger editor fails executing REST request

JsonStringEnumConverter

Swagger Editor Display Fault

Swagger Form Editor

requestInterceptor with Python