Stack Overflow
Stack Overflow

Questions tagged [api-documentation]

23 questions
6
votes
1 answer

what is the difference between postman collections and API documentation?

I have postman collections of some rest apis that I delivered to someone who want to do a secure assessment on them, however he asked for full API documentation, and I'm not very familiar with rest APIs, so what is the difference? ain't postman…
ethicalhacker
  • 119
  • 9
3
votes
1 answer

Swagger API having different response with the change of Optional Parameters

I am trying to create the OAS Swagger documentation for an existing API where the response for the API is changing on the basis of Query parameter. I am struggling to document this in a developer friendly way, so need some assistance. Below is the…
Aks
  • 55
  • 6
1
vote
0 answers

Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file

I'm writing in JS, and I use JSDoc comments to generate both my API documentation and my TypeScript declaration files. However, I have a couple of functions that I'd like to keep out of my TS code -- but I still want to include them in my API…
alec
  • 63
  • 6
1
vote
1 answer

Change the title in index.rst generated by Sphinx AutoAPI

I am looking for a way to rename the title in index.rst. AutoAPI generates a documentation of modules inside a directory ..\docs\source\_autoapi with index.rst file as follows: API Reference ============= This page contains auto-generated API…
Azka
  • 21
  • 2
1
vote
0 answers

Rswag specs failing for rspec

I am having a very strange issue while documenting the APIs with rswag. I have 15 rswag API documents that has been tested and working fine. But when I run the Rspec for login spec to see If it works or not. It throws an error saying invalid…
Hassan Ali
  • 35
  • 7
0
votes
1 answer

Swagger/OAS Schema design discussion

Background: We support an API guide directory where we document and show the different web services present in our system. There are many containers that group related services and few services have a common schema/model. For ex, ignore the…
N.A.
  • 1
  • 3
0
votes
0 answers

{controller} placeholder doesn't work when generating TypeScript client with NSwag

I want to generate a TypeScript client from an openApi specification. I'm using NSwagStudio to create the config file. I leave the default {controller}Client value, but the placeholder returns nothing, the class name will be just Client. What could…
Valentin Vadász
  • 55
  • 1
  • 6
0
votes
0 answers

Large Swagger Json file into multi json files

Hey Everyone So I am using lib flask-swagger-ui==4.11.1 in my flask application to host api documentation. The swagger.json now has become around 10000 of lines. So to avoid problems like merge conflicts and management I wrote a python script that…
harsh gupta
  • 65
  • 1
  • 1
  • 7
0
votes
0 answers

How to use swagger with a generic jaxrs api that writes response based on query params and response body is written using response builder class

How to use swagger with a generic jaxrs api that writes response based on query params and response body is written using response builder class... Any example would be appreciated. How to use swagger with a generic jaxrs api that writes response…
Rimi Gandhi
  • 11
  • 2
0
votes
0 answers

How to define two docs for two different URL patterns in Django rest?

ADMIN_API_SPECTACULAR_SETTINGS = { 'TITLE': 'Gravity API Admin', 'DESCRIPTION': 'Your admin API description', 'VERSION': '1.0.0', 'SCHEMA_PATH_PREFIX': '/admin-api/v1/', "POSTPROCESSING_HOOKS": [ …
Bibek
  • 21
  • 5
0
votes
0 answers

Which approach to choose in API management: "Code first" vs "Spec first"?

I need to decide, which approach to use in our project. I personally stick to the "Spec first" approach (or "Design first" approach). It means, that we first design an API specification, then approve it all together, then code the backend. But I…
Constantine Malyshev
  • 96
  • 3
0
votes
0 answers

how to customize the swagger UI/OpenApi in spring boot 3 without make my controller look clumsy

I would like to customize the swaggerUI with some custom messages. And i am able to create custom messages as below @ApiOperation(value = "Add a new car to the inventory", nickname = "addCar", response =…
user13876589
0
votes
1 answer

Create custom index.html in asp.net core Redoc as Api-Documentation

I'm using Asp.net core with Swagger and the Redoc as API-Documentation: app.UseReDoc(c => { c.DocumentTitle = "API Documentation"; c.SpecUrl = "/swagger.json"; }); And the default route for api-docs is /api-docs/index.html I…
Saeid Mirzaei
  • 950
  • 2
  • 18
  • 48
0
votes
1 answer

How to describe a model in Swagger for an array with simple objects?

I have a REST service to document, and some of them accept simple array like: [ { "name":"a" }, { "class":"b" }, { "hello":"c" } ] How do I describe this in the Swagger yaml model section? I can only create 'is_sellerarray' like { …
asim
  • 1
0
votes
0 answers

Redocly OpenAPI structure error. Property `openapi` is not expected here

I am trying to create an api documentation using redocly. On my openapi.yaml it is linking to a yaml that has the api docs called kpi-documentation.yaml link/$ref in openapi.yaml /kpiDocumentation: $ref: paths/kpi-documentation.yaml I have an…
B Ahern
  • 11
  • 4
1
2