cherrybomb VS swagger-php

Standard library does not provide all solutions for Error Handling.. In fact, different errors may be returned by the same function, making it increasingly difficult to handle them precisely. Personal anecdote, in our company we developed Cherrybomb an API security tool written in Rust, and we need to re-write a good part of it to have a better errors handling.

Cherrybomb is a CLI tool that helps you avoid undefined user behavior by auditing your API specifications, validating them, and running API security tests.

If you're looking for a new way to understand and manage your API, consider using OpenAPI, and if you want to secure it consider using CherryBomb to automate your security test. Managing and Testing it's the key,now your can keep your API safe :)

You can find the code on GitHub: https://github.com/blst-security/cherrybomb

API validation is an important part of developing and releasing a new API. It helps to ensure that the API behaves as expected and that it meets all the requirements of its users. Validating an API can be made easier with automated testing tools and CI/CD integrated validation 💡 tools, but it can also be done by hand.

You can learn more about Cherrybomb and how it can help you over at its repository.

I believe that Cherrybomb will make it simpler for developers to construct application programming interfaces (APIs) that are standardized, well-documented, and straightforward to implement. We have high hopes that Cherrybomb will emerge as the industry standard for application programming interface (API) development.

Native PHP attributes allowed OpenAPI markup to be much more compact than in DocBlocks. The resulting openapi.yaml is created with swagger-php and used to test the API.

First, swagger-php generates openapi.yaml based on code attributes, and then the spectator checks API responses to match openapi specification. The popular L5-Swagger is redundant in this case, as it is based on the same swagger-php with the addition of Swagger UI.

I do this except use https://github.com/zircote/swagger-php for writing the open api spec. I can enter the Spatie Data Object classes into the parameters, responses, and properties. Like op said though, it's a lot of comments and stuff to keep updated. Entirely using reflection (or reflection plus ability to manually specify certain extra things) like you're talking about sounds great.

wagger-php is a php swagger annotation and parsing library which generates interactive OpenAPI documentation for your RESTful API using doctrine annotations. - GitHub - zircote/swagger-php

The second one is L5 Swagger, a popular package bringing Swagger PHP and Swagger UI to Laravel. We actually don't need Swagger PHP here, as it uses Doctrine annotations to generate OpenAPI definitions and we're going to manually write our own instead. We do need Swagger UI, however, and the package conveniently adapts it to work with Laravel (the -W option is simply here to also update related dependencies, to avoid conflicts).

I need to create REST API documentation for a legacy Zend Framework 2 project. I tried to use zircote/swagger-php . It works with the new zf2 skeleton project but it fails when I use it in the legacy zf2 project. It adds Symfony/polyfill-php80 and it generates to issue. Anybody could help me on this issue. If you can suggest another package for API documentation also be a great help. Thanks.

It is possible that there is a library doing this already. I am not PHP coder so would like to avoid complex frameworks and stick with barebone solution doing only this Swagger/JSON stuff. For swagger, I decided to go with zircote/swagger-php. I would like my schema and model classes to have nice Swagger doc and at the same time I can use them to prepare objects to interact with the DB by loading/dumping from JSON.

I'm using this library to generate an open api 3 (swagger) yaml file. You add @OA markup to your doc blocks and then can have this generate a file or produce it on the fly. It's a bit sparse on documentation but is working really well with my MVC set up for a REST API I'm developing. https://github.com/zircote/swagger-php

I like the swagger way of generating schema's by annotating classes.. Swagger/OpenApi 3.0 uses a slightly modified subset of json schema, would that be of use to you?