Skip to content

swagger-ui user documentation #6161

Open
@mnagel

Description

@mnagel

Is your feature request related to a problem?

We have designed a beatiful API, documented it in OpenAPI, used a code generator to kickstart development, and have deployed the API to production. It comes with the swagger UI that documents the API and allows for interactive testing. Awesome!
Now we share the API with some less web-savvy clients and they wonder why there is no user manual for the swagger UI that goes trough the basics: mentions that you basically want to click one of the endpoints, click "Try it out", then edit the request parameters, then click "Execute", ...

Describe the solution you'd like

There should be a user manual for the swagger UI and it should be linked on the UI itself.

Describe alternatives you've considered

  • searched the web for a reasonably offical, reasonably beginner-friendly manual --> found nothing convincing
  • explaining the swagger UI in a telco using screen sharing -> does not scale

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions