164 questions
- Bountied 0
- Unanswered
- Frequent
- Score
- Trending
- Week
- Month
- Unanswered (my tags)
0
votes
2
answers
88
views
How to generate openapi docs offline with spring and kotlin
I'm trying to generate apidocs docs in a github pipeline, for a kotlin + spring + springdoc-openapi-starter-webmvc-ui, but I dont want to start the application and serve a localhost uri for openapi ...
1
vote
1
answer
60
views
Online API portal provider's parser doesn't parse the api doc(json) correctly when the request body's content type is x-www-form-urlencoded
Currently I am using the API portal service of apiable to test and publish the pre-developed APIs.
The problem is the apiable's doc parser doesn't parse correctly (the request body data's properties ...
0
votes
1
answer
699
views
How to define "interface" as a datatype in open API?
In my golang project, I have a structure that contains this field:
type hook struct {
Data interface{} `json:"data"`
}
How to represent this Data field in Open API Spec?
1
vote
0
answers
678
views
Laravel Scribe API docs generation - Public properties `auth`, `controller`, `method`, `route` not found on Knuckles\Camel\Output\OutputEndpointData
I use knuckleswtf/scribe package in my laravel apps to auto generate api docs from routes.
in one of laravel apps when I execute php artisan scribe:generate i get following error:
Spatie\...
0
votes
1
answer
537
views
How to use reference to joi schema with query parameters in swagger-autogen
I am using swagger-autogen to generate API documentation from Joi validations in my Express.js. I have this validation
const createCategoryBodySchema = Joi.object().keys({
parentId: Joi.number()....
0
votes
1
answer
919
views
How to render a hashmap with OpenAPI 3.1 and Nelmio?
I would like to correctly render a hashmap (key: a UUID, value: an object) both in the Response schema AND the Response samples (examples) sections of my API doc such:
{
"objects": {
&...
3
votes
0
answers
1k
views
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 ...
1
vote
1
answer
827
views
Using custom typehints with Sphinx and Pydantic
My Python project defines classes which inherit BaseModel from Pydantic.
I then run Sphinx on the project, using apidoc with autodoc-pydantic.
The problem is that Sphinx does not generate docs when a ...
0
votes
1
answer
498
views
Swagger request body format is not working well for nested data structure in nest
I am creating api using NestJS and making the api documentation using swagger.
Following code snippet is showing my dto definition.
export class CreateWoopDto {
@ApiProperty()
@IsUUID()
user_id: ...
0
votes
1
answer
338
views
Is there a way to automatically create axios requests code samples for Swagger API Design?
I wonder if I can generate code snippets or axios request sample codes for Swagger UI on my API documentation.
Is there any way to do it automatically?
6
votes
1
answer
5k
views
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 ...
1
vote
0
answers
208
views
How can I show some endpoints only admin
I created an apidoc when I published that everyone can see all endpoints. Is there a way to add restriction? I want to create an admin and user role. The admin can see all endpoints but user can see ...
1
vote
0
answers
189
views
How to define apiParam json object on apidoc
I want to define object apiParam for example
let data = {
id:null,
status:null,
category:null
}
The variable data is a json object I want to show object params on apiParam.
0
votes
1
answer
375
views
"required" Not showing in documentation generated by apidoc.js
I am trying to generate Rest api documentation using apidoc.js. Everything working perfect except the "required" marking not showing in documentation. like below
I have change template ...
3
votes
0
answers
137
views
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 ...