Stack Overflow
Stack Overflow

Questions tagged [api-doc]

Inline Documentation for RESTful web APIs. apiDoc creates a documentation from API annotations in your source code.

169 questions
0
votes
0 answers

Add meter to Openflow node in Opendaylight

I am trying to add a meter over rest in Opendaylight to configure the bandwidth of a particular flow entry. I am not able to do this at this time. I do not know what the problem is. Is it the node below that I have specified incorrectly? I am using…
Herms
  • 1
  • 2
0
votes
1 answer

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 class variable has a type hint of another class,…
Brian
  • 115
  • 8
0
votes
0 answers

Laravel Scribe Api Documentation - Skip a query string

I want to be able to "skip" an argument from the documentation. Use it like: /* * @queryParam some_param skip * or * @skipParam some_param */ It shouldn't matter from which strategy the param comes. Is this achievable with default scribe? In case…
Frederik B.
  • 196
  • 3
  • 11
0
votes
1 answer

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: string; @ApiProperty() @ValidateNested({…
Ping Zhao
  • 266
  • 5
  • 19
0
votes
1 answer

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?
Gabriel TN
  • 694
  • 1
  • 5
  • 9
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

Can I set token to authentication of Swagger after try it out request to login?

I am very new in swagger. Current, I need to write API document for my NodeJS app, use swagger to do it. Problem is I have to get JWT token and paste it to authentication box every time I open my api document. I am using Postman, and It's providing…
Vũ Anh Dũng
  • 980
  • 3
  • 13
  • 32
0
votes
0 answers

How to make scribe generated css files use the https protocol of the whole website

I decided to use Scribe to make documentation of my api. So i generated the docs folder offline then i pushed it onto app platform. Now when i load the page the page loads but the css files do not use the https protocol for the whole website. I…
Russel Dwight
  • 11
  • 1
  • 2
0
votes
0 answers

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 some endpoints on document. How can I do?
Fatih Doğan
  • 417
  • 1
  • 4
  • 16
0
votes
0 answers

How do add swagger annotations appropriately to every endpoint in JSON in order to publish an open API doc?

I'm working on a project in which I'm required to add swagger annotations to endpoints in a postman collection in a JSON file on GitHub. I'm a beginner in API documentation and I've not sure how to go about this. Any suggestions?
Jeff Omenyuru
  • 1
  • 1
0
votes
0 answers

How to reflect apidoc verion in URL

https://github.com/apidoc/apidoc Is there a way to change the apiDoc URL when the version is selected? I copy the URLs from apiDoc to the code, but when I use URLs from 2.0.0 and access them it defaults to 1.0.1, and I have to manually select 2.0.0…
Coding Edgar
  • 1,285
  • 1
  • 8
  • 22
0
votes
0 answers

Convert apiDoc.json to swagger.json

I'm trying to convert a apiDoc json file to swagger json file, I have tried a few npm modules but none of them actually worked. Does anyone have experience on the conversion? thank you!
Zhu Troy
  • 1
0
votes
1 answer

"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 setting showRequiredLabels to true as per the documentation.…
ARi
  • 78
  • 14
0
votes
1 answer

APIDoc with NodeJS: EvalError while serving documentation page

I'm using APIDoc to generate API documentation of my NodeJS app. I'm facing problem while serving generated index.html page: Uncaught EvalError: Refused to evaluate a string as JavaScript because 'unsafe-eval' is not an allowed source of script in…
Qamar Zaman
  • 1
0
votes
1 answer

The annotation "@apiDefine" in class App\Controller\UserController was never imported

I am using both phpstan and apidoc, but i have an error on phpstan that i can't find a way to solve or ignore. Error message "Internal error: [Semantical Error] The annotation "@apiDefine" in class App\Controller\UserController was never imported.…
Gregory Boutte
  • 584
  • 6
  • 26
1 2 3
…
11 12