https://github.com/sillyash/swagger-ui-clickable-links-plugin
A Swagger UI plugin that automatically makes URLs in descriptions and examples clickable.
https://github.com/sillyash/swagger-ui-clickable-links-plugin
openapi openapi3 plugin rest-api swagger-ui
Last synced: 9 months ago
JSON representation
A Swagger UI plugin that automatically makes URLs in descriptions and examples clickable.
- Host: GitHub
- URL: https://github.com/sillyash/swagger-ui-clickable-links-plugin
- Owner: sillyash
- License: gpl-3.0
- Created: 2025-09-12T07:56:10.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-19T09:57:17.000Z (9 months ago)
- Last Synced: 2025-09-19T11:44:09.571Z (9 months ago)
- Topics: openapi, openapi3, plugin, rest-api, swagger-ui
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/swagger-ui-clickable-links
- Size: 73.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# swagger-ui-clickable-links
A Swagger UI plugin that automatically makes URLs in descriptions and examples clickable.
## Features
- Detects URLs in API responses and examples.
- Makes URLs clickable with proper `target="_blank"` and security attributes.
- Works with both JSON and plain text responses.
- Seamlessly integrates with existing Swagger UI installations.
## Usage
### With CDN
```html
SwaggerUIBundle({
dom_id: '#swagger-ui',
url: 'https://petstore.swagger.io/v2/swagger.json',
plugins: [ SwaggerUIClickableLinks ],
});
```
### With npm
```bash
npm install swagger-ui-clickable-links
```
```javascript
import SwaggerUI from 'swagger-ui';
import SwaggerUIClickableLinks from 'swagger-ui-clickable-links';
SwaggerUI({
dom_id: '#swagger-ui',
url: 'https://petstore.swagger.io/v2/swagger.json',
plugins: [ SwaggerUIClickableLinks ],
});
```
## Example
Check the `example/` directory for a complete working example.
---
## License
GPL-3.0 - see [LICENSE](LICENSE) for details.
## Contributing
Feel free to open issues or submit pull requests for improvements or bug fixes.