openapi: 3.0.3 info: title: "{Service Name} API" description: "API specification for {service description}" version: 0.1.0 contact: name: "{Team Name}" servers: - url: https://api.example.com/v1 description: Production - url: https://api.staging.example.com/v1 description: Staging paths: /example: get: summary: "Example endpoint" description: "Describe what this endpoint does" operationId: getExample tags: - example parameters: - name: id in: query required: true schema: type: string description: "Resource identifier" responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/ExampleResponse" "400": description: Bad request "401": description: Unauthorised "404": description: Not found "500": description: Internal server error components: schemas: ExampleResponse: type: object required: - id properties: id: type: string description: "Resource identifier" created_at: type: string format: date-time description: "Creation timestamp" securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT security: - bearerAuth: []