Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automatically generate documentation - openAPI (swagger) #205

Open
avelino opened this issue Dec 23, 2023 Discussed in #174 · 0 comments · May be fixed by #262
Open

automatically generate documentation - openAPI (swagger) #205

avelino opened this issue Dec 23, 2023 Discussed in #174 · 0 comments · May be fixed by #262
Assignees
Labels
:devx :enhancement New feature or request :feature
Milestone

Comments

@avelino
Copy link
Member

avelino commented Dec 23, 2023

Discussed in #174

Originally posted by avelino November 6, 2023
Have an option in the endpoint configuration to generate endpoint documentation (with swagger)

- endpoint:
    method: GET
    path: /hello/:username
    doc: true # or `swagger: true`
    response:
      status: 200
      headers:
        Content-Type: application/json
      body: >
        {
          "hello": "{{path-params.username}}!"
        }

The OpenAPI Specification is a specification language for HTTP APIs that provides a standardized means to define your API to others. You can quickly discover how an API works, configure infrastructure, generate client code, and create test cases for your APIs. Read more about how you can get control of your APIs now, understand the full API lifecycle and communicate with developer communities inside and outside your organization.

@avelino avelino added :enhancement New feature or request :feature :devx labels Dec 23, 2023
@avelino avelino removed their assignment Feb 19, 2024
@avelino avelino added this to the 0.3.1 milestone Feb 20, 2024
@avelino avelino modified the milestones: 0.3.1, 0.3.2 Apr 8, 2024
@avelino avelino modified the milestones: 0.3.2, 0.3.3 Apr 17, 2024
@avelino avelino modified the milestones: 0.3.3, 0.3.4 Apr 25, 2024
@matheusfrancisco matheusfrancisco linked a pull request May 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:devx :enhancement New feature or request :feature
Projects
Status: Q3/24 – Apr-Jun
Development

Successfully merging a pull request may close this issue.

2 participants