Comments (1)
Hi,
this library focuses on openapi/swagger only, so there is no plan to support websockets.
You can filter out routes with the pathFilter
-config-option:
install(SwaggerUI) {
pathFilter = { method, url -> /*return 'false' to exclude them from the api-documentation*/ }
}
or directly in the documentation of routes:
get("hidden", {
hidden = true // exclude this route from the api-documentation
}){
// ...
}
route("myresources", {
hidden = true // exclude all routes below '/myresources' from the api-documentation
}) {
get {
//...
}
}
from ktor-swagger-ui.
Related Issues (20)
- Too complex HOT 6
- Issues with generated schemas HOT 8
- [outdated] Documentation Example Serialization HOT 2
- Structural error at components.securitySchemes HOT 1
- Structural error at components.securitySchemes HOT 2
- How to Turn Off Swagger-ui in Production? HOT 1
- How to avoid RateLimit path HOT 2
- Setting custom rootHostPath in swagger context doesn't work properly HOT 1
- What is the minimum version of the Ktor framework supported by the plugin? HOT 2
- Bump victools/jsonschema-generator to 4.33+ for Option.INLINE_NULLABLE_SCHEMAS
- How to generate documentation of a sealed class using kotlinx.serialization HOT 1
- Doesn't work correctly with RateLimit Plugin HOT 2
- Unable to use schemasInComponentSection = true HOT 1
- Is there a way to hide custom plugin in the swagger UI? and the lock icon doesn't appear on the swagger ui HOT 2
- How to add a path that is not in the ktor project
- How do I add a request of type FormUrlEncoded? HOT 2
- @JsonProperty annotation and schema generation HOT 1
- Lowe case path parameter options HOT 1
- Allow change the path of api.json HOT 2
- Schema(name) annotation fails to apply in certain cases HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ktor-swagger-ui.