swagger-ui

Q&A (please complete the following information)

Method of installation: [npm, dist assets]
Swagger-UI version: [>=3.25.1]
Swagger/OpenAPI versi

Description

How can I use socket.io instead of the plain websocket integration? I guess this is more a question belonging to starlette.

Currently migrating from a flask application using flask-socketio / python-socketio

Any hint is appreciated. Thx.

There is absolutely no documentation (other than "this is how you drop an existing file". What is the point of releasing such a product if you do not document it?

In #434, it was reported that there were inline scripts that caused the docs to break when a CSP policy blocked those inline scripts. This was fixed in DRS 2.0.

In #637, another inline script was introduced, causing this to break again.

Copied from #103

I've resolved the issue of authentication using the next code:
swagger_template = { ..., 'securityDefinitions': { 'basicAuth': { 'type': 'basic' } }, ... }
app = Flask(__name__)
Swagger(app, config=config[config_name].swagger_config, template=swagger_template)

![image](https://use

I'm new to rest_framework but I'm using drf in combination with redoc and this library and it seems to work fantastic.

I was wondering how can I generate custom sections of the documentation for objects that are commonly reused across all API calls. For example, I have a token object that is query/post parameter so I would like this to be explained topic in its own section.

With the help of

Didn't find anything in the docs&tutorials — what is the right way to dynamically at runtime set result status code, http headers, redirects or template to render inside controller action?

Like you do in rails etc.?

Hi together,

I just started using swagger-jsdoc in my nodejs project using Typescript. It was kind of hard to figure out how to use it due to the transpilation process involved.

There are a few workarounds necessary to make it work:

apis [...] has to point to files in the /dist directory due to the transpilation process
Annotations (in the comments) to model classes are lost in the t

The README explains how to customize swagger-ui by generating and editing the app/views/rswag/ui/home/index.html.erb template file. This works!

It would be neat if I could configure swagger-ui -- particularly the parameters described in the docs -- by setting the desire

Adding examples responses.
I see there is a method to add responses @doc.response but is there a method to add example responses?

It would be nice if @doc.example() added example code to the OpenApi spec.

Slightly related question
Is there a way to populate the Example Value box with a real example, or will that only

Hello,
I want to use another db instance for swagger documentation because if we use same db instance on production. there is fear of changes which can be made anyone who is using documentation. So different db for application and another one for documentation. How it can be done using swagger-lume???

Thank you very much for the code. It's very useful, but there's a little problem.

Expected Behavior

https://alibaba-easyexcel.github.io/

I set 'keywords' and I wanted it to be keywords for <head></head> in HTML.

Actual Behavior

Can't find keywords and description tag.

Describe the feature

Introduce new configuration option to choose collapse mode of generated swagger UI documentation.

The template of swagger UI itself allows easily to define default collapsing behavior over "docExpansion" property in SwaggerUIBundle definition.

See:
https://github.com/int128/gradle-swagger-generator-plugin/blob/0857fe89d0134a38678f1f510669b8510d22e33a/src/main/resour

Hello,

Apologies if this is a noobish question. I notice that the readme states RestRserve supports HTTPS; however is there anywhere that the process of adding this is documented?

swagger-ui

Here are 1,005 public repositories matching this topic...

macrozheng / mall

swagger-api / swagger-ui

Q&A (please complete the following information)

tiangolo / fastapi

swagger-api / swagger-editor

marcgibbons / django-rest-swagger

flasgger / flasgger

xiaoymin / swagger-bootstrap-ui

zhangdaiscott / jeecg

geekidea / spring-boot-plus

axnsan12 / drf-yasg

DarkaOnLine / L5-Swagger

TypedProject / tsed

Surnet / swagger-jsdoc

rswag / rswag

springdoc / springdoc-openapi

tiangolo / uvicorn-gunicorn-fastapi-docker

ostranme / swagger-ui-themes

huge-success / sanic-openapi

mrin9 / RapiDoc

DarkaOnLine / SwaggerLume

zalando-incubator / hexo-theme-doc

Expected Behavior

Actual Behavior

dotnetzoom / AspNetCore-WebApi-Course

essuraj / swagger-toolbox

int128 / gradle-swagger-generator-plugin

Describe the feature

rexyai / RestRserve

Caratacus / Crown

zhaopei8948 / springboot

Orange-OpenSource / angular-swagger-ui

twskj / pretty-swag

cyantarek / django-microservices

Improve this page

Add this topic to your repo