Skip to content

Example payloads in OpenAPI/Swagger UI #286

@schrieveslaach

Description

@schrieveslaach

Often people maintain a collection of payloads in Content Management Systems, e.g. Confluence, which requires people to copy & paste things around (which is a bit error prone). With the Swagger UI capability to attach many examples to endpoints (see here), PREvant could over a configuration option to include many examples that are tailored towards the specific use of a PREvant instance.

Some additional thoughts:

  • The configured examples should be validated if they match to the PREvant HTTP body payload before sending to the client
  • Rendering/templating could be integrated into this feature too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions