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.
How to enable deepLinking when using swagger-ui-react
See original GitHub issueQ&A (please complete the following information)
- OS: Linux
- Browser: Chrome
- Version: 76
- Method of installation: npm
- Swagger-UI version: 3.23.6
- Swagger/OpenAPI version: Swagger 2.0 and OpenAPI 3.0
Swagger-UI configuration options:
import SwaggerUI from 'swagger-ui-react'
export default () => <SwaggerUI url={url} docExpansion="list" deepLinking={true} />
How can we help?
I’m trying to use swagger-ui-react inside a react application and according to the documentation, it seems the amount of supported options is quite reduced compared to what swagger-ui supports.
I was specially trying to enable deeplinking, but apparently any prop other than the 5 which are documented are ignored.
Is there any way to define these props?
Issue Analytics
- State:
- Created 4 years ago
- Reactions:5
- Comments:9
Top Results From Across the Web
deepLinking parameter
Swagger UI allows you to deeply link into tags and operations within a spec. When Swagger UI is provided a URL fragment at...
Read more >Have you heard of Deep Linking in Swagger?
This article demonstrates steps to enable deep linking in swagger UI inside a .Net Core API. What is deep linking? Deep linking allows...
Read more >Is there a way to prefix deeplinking fragment of swagger ui?
1) with deep-linking enabled. when ever I click on a tag or operation it appends the #/{tagName}/{operationId} to the base URL of app...
Read more >Add support for deep-linking into specific APIs in Swagger ...
I would like you to add support for the 'deepLinking' parameter that is part of the Swagger UI configuration. This allows links to...
Read more >Using OpenAPI and Swagger UI
If set to true, enables deep linking for tags and operations. Environment variable: QUARKUS_SWAGGER_UI_DEEP_LINKING. Show more.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I have just tested it with latest swagger-ui-react, and it works perfectly. I was able to drop the component I was maintaining myself 🙂
Also, at the moment of writing this,
@types/swagger-ui-reactalready supports the property.So closing this.
Thanks for letting us know @samarthd