Questions tagged [redoc]
94 questions
1
vote
0 answers
Converting from *.docx using redoc::dedoc corrupt
I have created a word file from an rmarkdown file using redoc output directly in RStudio and clicking "knit". This works fine.
---
title: "Untitled"
output:
redoc::redoc
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
##…
HCAI
- 2,213
- 8
- 33
- 65
1
vote
2 answers
How to group swagger API endpoints (Function Based Views) with drf_yasg - Django
I am doing some migration work from Django 1.11 --> 3.1.5
previously with "rest_framework_swagger", I am able to accomplish swagger api grouping just by this in url.py
url(r'^api/v9/test_token1$',
api.test_token,
…
Axil
- 3,606
- 10
- 62
- 136
1
vote
1 answer
Reference server URL in Location response header
In the server object I defined an URL:
servers:
- url: https://localhost:8088/abc
and in the response definition I want to reference this server URL:
/test-sub-url:
post:
requestBody:
required: true
content:
…
Mathias Kogler
- 140
- 8
1
vote
0 answers
Detect file changes and convert the file from yaml to html continuously using dockerfile
My dockerfile -
FROM node:alpine
RUN npm install -g redoc-cli
WORKDIR /data
EXPOSE 8080
ENTRYPOINT ["redoc-cli"]
CMD []
Build and run command-
docker build -t anyname .
docker run -v $PWD:/data -t anyname bundle test.yaml
Using above command, I…
Hassan Rahman
- 35
- 9
1
vote
2 answers
How can I have dropdown for different API version in REDOC c#
Here is my configuration in the startup.cs
services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(1, 0);
options.AssumeDefaultVersionWhenUnspecified = true;
…
x3weird-
- 74
- 2
- 11
1
vote
0 answers
x-codeSamples not showing in Swashbuckle.AspNetCore
I am working with Swashbuckle.AspNetCore and add x-codeSamples with the bellow code:
public class XCodeSamplesFilter : IDocumentFilter
{
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
string source =…
kuntal
- 1,591
- 2
- 16
- 36
1
vote
0 answers
Using path paramter as value for request body
Use path parameter petId as field value for id in request body. How can we do it?
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets/{petId}:
…
Alwyn Lvv
- 11
- 1
1
vote
1 answer
ReDoc + SWAGGER + Spring Boot - response samples
Currently I am working on my API documentation and I decided to implement it with ReDoc.
My API built using Spring Boot..and for the documentation I am using SWAGGER. Everything is fine, but I am unable to annotate my Controller to show the…
csirkeautomata
- 177
- 3
- 16
1
vote
2 answers
How to customize API end points on redoc API documentation
I am using redoc in django==2.0 for documenting some django API. I noticed that by default redoc will name the endpoints automatically as you can see on the image below on the left side. Most likely I don't want to use the names generated I want…
Philip Mutua
- 6,016
- 12
- 41
- 84
0
votes
1 answer
Why does "Invalid JSON pointer" error occurs when building API docs using Redocly?
I am trying to build an API doc using OpenAPI specifications. I am using Redocly CLI for building the UI by using this command:
redocly build-docs openapi/openapi.yaml
But I am getting this error:
Found undefined and using theme.openapi…
Deep
- 123
- 1
- 3
- 16
0
votes
1 answer
Collect Redoc FastAPI from some instances on an one page
Is there any convenient way to put Redoc together from some insurances running on several ports, for instance:
http://127.0.0.1:8000/redoc
http://127.0.0.1:8001/redoc
http://127.0.0.1:8002/redoc
http://127.0.0.1:8003/redoc
Each instance presents…
Aex
- 1
- 1
0
votes
0 answers
How to add sample responses for Form inputs in FastAPI redoc documentation?
I have the following request:
@app.post("/api/add_profile", description = "Add your details here")
async def your_profile(name: str = Form(description = "Enter your full name"),
intro: str = Form(description = "Write a short introduction, this …
Deepali
- 31
- 2
0
votes
0 answers
Generating Schema in API documentation with redocly
I am using redocly for generating API documentation. Currently redocly generates API documentation for endpoints (paths), but does not generate schema documentation. This blog on their website explains how to generate the schema section by…
Amrish
- 679
- 1
- 8
- 20
0
votes
1 answer
Is it possible to emulate remote URL behavior using local browser object?
I am using Redoc standalone with our API server. After redoc.standalone.js is loaded, redoc tries to fetch schema.yaml from the API server. However, our server needs an Authorization header with token, which Redoc does not include by default. I am…
rzlvmp
- 7,512
- 5
- 16
- 45
0
votes
0 answers
How to enable "try it" feature on Redoc page, as shown in the picture
The image is from here. (It is not my website.)
My backend framework is based on Django REST Framework.
I am able to use the "Try it" functionality in Swagger, but I don't really want to use it because Swagger does not support a left-hand side menu…
children1987
- 21
- 4