NelmioApiDocBundle | Generates documentation for your REST API from annotations | REST library

by nelmio PHP Version: v4.11.1 License: MIT

X-Ray Key Features Code Snippets Community Discussions(8)Vulnerabilities Install Support

kandi X-RAY | NelmioApiDocBundle Summary

NelmioApiDocBundle is a PHP library typically used in Web Services, REST, Symfony applications. NelmioApiDocBundle has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

[Latest Stable Version] The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Support

Quality

Security

License

Reuse

Support

NelmioApiDocBundle has a medium active ecosystem.

It has 2131 star(s) with 824 fork(s). There are 66 watchers for this library.

It had no major release in the last 12 months.

There are 98 open issues and 978 have been closed. On average issues are closed in 76 days. There are 18 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of NelmioApiDocBundle is v4.11.1

Quality

NelmioApiDocBundle has 0 bugs and 0 code smells.

Security

NelmioApiDocBundle has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

NelmioApiDocBundle code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

NelmioApiDocBundle is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

NelmioApiDocBundle releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

NelmioApiDocBundle saves you 1439 person hours of effort in developing the same functionality from scratch.

It has 3972 lines of code, 223 functions and 73 files.

It has medium code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed NelmioApiDocBundle and discovered the below as its top functions. This is intended to give you an instant insight into NelmioApiDocBundle implemented functionality, and help decide if they suit your requirements.

Handles the service configuration .
Find form type .
Get the configuration tree builder .
Describe a model .
Process property annotations
Get class and method name from controller .
Generate OpenAPI .
Merge annotation from array .
Register the schemas .
Checks if the route matches with annotations .

Get all kandi verified functions for this library.

NelmioApiDocBundle Key Features

No Key Features are available at this moment for NelmioApiDocBundle.

NelmioApiDocBundle Examples and Code Snippets

No Code Snippets are available at this moment for NelmioApiDocBundle.

Community Discussions

Trending Discussions on NelmioApiDocBundle

Symfony 6 - lexik JWT - Authenticator does not support the request

Symfony NelmioAPIDocBundle: Remove Logo Header?

How to set @SWG\Info annotation for only area in Symfony using NelmioApiDocBundle

Symfony api/doc route shows 404 on live server, but is OK on localhost

NelmioApiDocBundle negative path_patterns

NelmioApiDocBundle set Response content type as file

How to add JSON request and response examples in Swagger (OpenApi)?

Nelmio API doc area and bearer token with symfony 4

QUESTION

Symfony 6 - lexik JWT - Authenticator does not support the request

Asked 2022-Feb-06 at 20:54

I'm having some problems with lexik JWT bundle and Symfony 6.0, for swagger I use NelmioApiDocBundle.

The thing is, that every in swagger works before I decide to apply my Authorization Token (Bearer token), which is generated from lexik JWT. But once I get my token generated through /api/sign/in endpoint, and put it into the field, suddenly all endpoints stop working. Like the swagger has this loading animation, but no request comes (tested with xDebug, but also symfony profiler).

Funny thing is when I use Postman and apply the token there, I immediately get a correct response. So I'm not sure where or what's the problem, but when calling from Swagger, I can see docker debug messages saying: PHP message: [debug] Authenticator does not support the request.

I will put my configuration below. Thanks in advance.

lexik_jwt_authentication.yaml:

...

ANSWER

Answered 2022-Feb-06 at 20:54

found out api_platform swagger and nelmio are both interacting somehow, since I added this into api_platform.yaml and the header was available in nelmio too, which now works.

Source https://stackoverflow.com/questions/71011241

QUESTION

Symfony NelmioAPIDocBundle: Remove Logo Header?

Asked 2021-Nov-03 at 22:35

Is it possible to remove the logo header shown in the web-based output of NelmioApiDocBundle? And if so, how?

I would like to include the output of this endpoint (/api/doc if you're using the default settings) in an existing website. However, that site already has a header, and adding a second header would be a poor user experience IMHO. But I can't find any place in the documentation that describes how to exclude this gloriously 1990s-style piece of web design.

I've provided a screenshot of the default config below, which is what I get when viewing the docs in a tool like Insomnia. As you can see, the green header is covering the page as it scrolls.

...

ANSWER

Answered 2021-Oct-17 at 23:05

Yes, you can do it.

You should override bundle template, say steps bellow :

1 - Create template file in 'templates/bundles/NelmioApiDocBundle/SwaggerUi/index.html.twig'

2 - Put the content bellow :

Source https://stackoverflow.com/questions/69597851

QUESTION

How to set @SWG\Info annotation for only area in Symfony using NelmioApiDocBundle

Asked 2021-Sep-22 at 11:32

/**
 * @SWG\Swagger(
 *   @SWG\Info(
 *     title="My first swagger documented API",
 *     version="1.0.0"
 *   )
 * )
 */

...

ANSWER

Answered 2021-Sep-22 at 11:32

• For controller try:

Source https://stackoverflow.com/questions/69282856

QUESTION

Symfony api/doc route shows 404 on live server, but is OK on localhost

Asked 2021-Aug-07 at 11:48

I have deployed my Symfony 5 app on live server (production). I left my .env file with DEV variables.

Firstly my my homepage index.php was showing 404 URL not found on the server, so I had to execute ln -s public_src public and since that my homepage was showing fine.

However I required and implemented a NelmioApiDocBundle via composer and now my API doc route /api/doc is working only on localhost, on live server (production) the browser says 404 URL not found on the server.

How to fix it? Does it need another symlink?

...

ANSWER

Answered 2021-Aug-07 at 11:48

You need to set the .htaccess file under public folder.

Source https://stackoverflow.com/questions/68676122

QUESTION

NelmioApiDocBundle negative path_patterns

Asked 2021-Feb-27 at 21:23

Right now I try to create an API documentation in Symfony 3 with the NelmioApiDocBundle. So far everything works as described in the given symfony documentation.

Now I'd like to remove the _error and _profiler routes from the swagger docs. It says you can just use path_patterns. So I need to write down all routes there which I need in the documentation. But I have quite some different pathes.

It would be cool to have the opportunity to create negative path patterns like

...

ANSWER

Answered 2021-Feb-27 at 21:21

Those are regex patterns so, yes you should be able to match any kind of pattern regex allows.
Check out "lookaround" zero-length assertions, specifically a Negative lookahead, and try something like below:

Source https://stackoverflow.com/questions/66382525

QUESTION

NelmioApiDocBundle set Response content type as file

Asked 2021-Jan-15 at 13:19

I am using NelmioApiDocBundle 4.0 to generate the documentation of my API. The problem started when i tried to set a response type as a file. I have a method that gets a file from database and returns it as StreamedResponse:

...

ANSWER

Answered 2021-Jan-15 at 13:19

You need to put @OA\Schema inside @OA\MediaType:

Source https://stackoverflow.com/questions/65729835

QUESTION

How to add JSON request and response examples in Swagger (OpenApi)?

Asked 2020-Oct-05 at 14:44

I have an API endpoint in my Symfony 4 application, that I want to document with NelmioApiDocBundle and Swagger. The endpoint takes JSON as a request data and also returns some custom JSON as the response. How can I add examples of them to the documentation, using annotations? I can't see any of the examples on the documentation page, only the description.

...

ANSWER

Answered 2020-Oct-05 at 14:44

For NelmioApiDocBundle v4 you can do like this

Source https://stackoverflow.com/questions/64208289

QUESTION

Nelmio API doc area and bearer token with symfony 4

Asked 2020-Apr-09 at 09:36

I have API in Symfony 4. I added NelmioApiDocBundle to my project, but i have problem with my docs. This is my configuration: packages\nelmio_api_doc.yaml

...

ANSWER

Answered 2020-Jan-20 at 02:56

You will need to annotate your controllers with tags:

Source https://stackoverflow.com/questions/59813695

Community Discussions, Code Snippets contain sources that include Stack Exchange Network