Stack Overflow
Stack Overflow

Questions tagged [redoc]

94 questions
12
votes
2 answers

Django Rest Framework custom POST URL endpoints with defined parameter (request.POST) with Swagger or other doc

previously in Django 1.11, I'ved defined Django REST API in this way: in url.py url(r'^api/test_token$', api.test_token, name='test_token'), in api.py @api_view(['POST']) def test_token(request): # ----- YAML below for Swagger ----- """ …
Axil
  • 3,606
  • 10
  • 62
  • 136
12
votes
1 answer

Problem reusing serializers with django and drf-yasg

I am using django, django drf and drf-yasg to generate write my BE and generate documentation. I have a model called User and a serializer for a user: class UserSerializer(serializers.ModelSerializer): class Meta: model =…
Belgi
  • 14,542
  • 22
  • 58
  • 68
9
votes
3 answers

Is there an OpenAPI type specification for Kafka or similar technology?

OpenAPI is good for RESTful services and at the moment, I'm hacking it to do it for asynchronous messaging system (specifically Kafka) by using POST to a /topic so that I can use redoc do create a website for the API. I am trying to see if there's…
Archimedes Trajano
  • 35,625
  • 19
  • 175
  • 265
5
votes
1 answer

How to vary the required fields for POST and PUT in Swashbuckle?

I'm responsible for maintaining the company API documentation. Our API is written ASP.NET. I recently switched to using Swashbuckle 5.6.0 which is working nicely. The issue I've come accross is this: We separate our data models into Post data and…
Matt Clegg
  • 359
  • 1
  • 4
  • 17
4
votes
1 answer

How to document individual actions of a ViewSet using `drf-spectacular`?

Using DRF's built-in way of documenting the API, I was able to write a docstring like the following and each action was documented by its corresponding line: """ list: The list action returns all available objects. retrieve:The retrieve action…
finngu
  • 457
  • 4
  • 23
4
votes
1 answer

How do you use reDoc with multiple files

My API documentation is getting quite large and I was wondering if it was possible to separate the openapi.yml file into separately managed chunks rather than having it all in one and have reDoc (or some other tool) combine it and then generate the…
Archimedes Trajano
  • 35,625
  • 19
  • 175
  • 265
3
votes
0 answers

How to uninitialize (destroy) Redoc?

I am using Redoc to generate API docs GUI. The application is made as single page application including API docs. But there is an issue in the Redoc behaviour. When Redoc is initialized and rendered and I click on another page which is longer than…
Honza
  • 939
  • 2
  • 11
  • 28
3
votes
1 answer

API Documentation with ReDoc and Spring boot

Could someone share some examples on how to implement API Documentation using ReDoc along with SpringBoot framework. It would be great help if someone knows some good examples with ReDoc + Springboot.
Varun
  • 85
  • 1
  • 7
3
votes
1 answer

How to add x-server & x-taggroups for ReDoc through drf-yasg

I am using drf-yasg for documentation,I am using redoc and it's working great. But I want to add x-server and x-taggroups. I would like to set custom tags for views, and add them to their own taggroups, but I cannot find anything in the docs about…
Anmola Singh
  • 31
  • 1
2
votes
0 answers

Using go-swagger, how to have the @description reference an external Markdown file?

So I am using the above two technologies to autogenerate my swagger.yaml file that then is read by Redoc and served to the clients. This is the step in my makefile: swag init -g internal/delivery/rest/router.go --output swagger/ --outputTypes…
Matias Barrios
  • 4,674
  • 3
  • 22
  • 49
2
votes
1 answer

How to create Request samples for Form input in FastAPI?

I wish to create sample requests for my API documentation in Swagger UI, but I am accepting Form input. FastAPI docs demonstrate how to do that only for Pydantic schema. Please help me with this Can example/examples be used for Form input to create…
Deepali
  • 31
  • 2
2
votes
1 answer

OpenAPI Spec: what is suitable license for a private and internal OpenAPI doc?

My company uses Open API Spec to organize the doc for internal APIs and render it through UI tools, for example, redoc.ly or Swagger. The API doc is managed as a private git repo and will never be released to the public. License for private API…
Ryan Lyu
  • 4,180
  • 5
  • 35
  • 51
2
votes
1 answer

Is it possible to hide the file name of a ref when used in schema definition?

My openapi.yml file endpoint looks like this: /v2/myendpoint: get: summary: Retrieve stuff requestBody: required: true content: application/json: schema: $ref:…
Danielle McCarthy
  • 31
  • 1
2
votes
2 answers

redoc not showing authentication section

I have an openapi.yml that I edit with IntelliJ. When I preview the file using the OpenApi Editor plugin (with redoc), there is an authentication section (literally
Cephalopod
  • 14,632
  • 7
  • 51
  • 70
2
votes
0 answers

How to remove trailing CRUD names from django-restframework yasg redoc schema?

Is there a way to remove the CRUD names like _list and _create from the API endpoint titles in the left panel? djangorestframework==3.12.4 drf-yasg==1.20.0
Alireza Mastery
  • 97
  • 1
  • 7
1
2 3 4 5 6 7