question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Visualize the OpenAPI document at a standard URI

See original GitHub issue

At our weekly hangout today we discussed the possibility of a spec-defined URL where a user could visualize the generated OpenAPI document. The idea is that the spec would indicate how to enable/disable such a feature and specify where a user could find such a visualization. This would probably be similar to validation in approach (config property to enable/disable and well defined endpoint to load the UI) but is also open for discussion of course.

As an example of what this might look like for a vendor - Open Liberty provides an endpoint (e.g. /openapi/ui that results in Swagger UI being opened with the generated OpenAPI document.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:2
  • Comments:9 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
arthurdmcommented, Jul 9, 2019

I agree @EricWittmann

Seeing that there have been no objections to our latest proposal I added the help wanted label so anybody can pick this up and complete it.

1reaction
EricWittmanncommented, Jul 9, 2019

Well, I would say that implementors are always free to offer whatever non-conforming options they choose. So out of scope of the spec document IMO.

Read more comments on GitHub >

github_iconTop Results From Across the Web

OpenAPI Specification - Version 3.0.3
This document is licensed under The Apache License, Version 2.0. Introduction. The OpenAPI Specification (OAS) defines a standard, language-agnostic interface ...
Read more >
Using OpenAPI and Swagger UI
Swagger UI is a great tool permitting to visualize and interact with your APIs. The UI is automatically generated from your OpenAPI specification....
Read more >
OpenAPI 3.0 Tutorial | SwaggerHub Documentation
In this tutorial, we will write a simple API definition in the OpenAPI 3.0 format. If you are using OpenAPI 2.0 (Swagger 2.0),...
Read more >
OpenAPI Specification v3.1.0 | Introduction, Definitions, & ...
The OpenAPI Specification (OAS) defines a standard, ... definition can then be used by documentation generation tools to display the API, ...
Read more >
OpenAPI 3.0: How to Design and Document APIs ... - YouTube
The OpenAPI Specification (OAS), based on the original Swagger 2.0 specification, has emerged as the world's standard for defining and ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found