Skip to content

OpenAPI / Swagger support #348

Description

@pavanpodila

Problem to Solve

It would be great to automatically generate an OpenAPI spec in a document that will showcase all the APIs that are currently part of the Relic Server. This is a standard feature for most API servers and is available in pretty much every other framework out there, in other languages.

https://swagger.io/

Proposal

Based on what's generated inside the relic APIs, it should automatically detect the shape of the object and generate the corresponding OpenAPI spec.

Use Case

Ability to browse all the APIs and test them, and even share with the rest of the team

Alternatives

I think a project called Serenius is already doing it.

Additional context

No response

How experienced are you with this library?

Intermediate - Familiar with the basics or have used it in a few projects

Are you interested in working on a PR for this?

  • I want to work on this

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: routingIssues related to routing.enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Backlog 🗂️

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions