swagger-php
swag
Our great sponsors
swagger-php | swag | |
---|---|---|
10 | 36 | |
4,946 | 9,633 | |
- | 2.9% | |
8.1 | 7.7 | |
1 day ago | 8 days ago | |
PHP | Go | |
Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger-php
-
Workplaces for digital nomads: the API
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.
-
Pragmatic development
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.
-
Swagger/Open api integration in laravel
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.
-
OpenAPI Specification: The Complete Guide
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
-
Validate your PHP API tests against OpenAPI definitions – a Laravel example
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).
-
Dynamic class property with phpdoc included
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.
-
Creating API documentation from php files?
Ah right, so you're building a (presumably REST) API and you want to generate docs for the endpoints from your code. Slightly different scenario to what I assumed. There are a couple of libraries to generate OpenAPI specs from source files, I think this is the main one https://github.com/zircote/swagger-php though FWIW I prefer to maintain my API specs separately from the code and use those to guide what I'm building, rather than 'tother way round.
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
swag
-
Seeking Advice on the Best Swagger Generation Approach for REST API
Hey Gophers, I'm exploring Swagger generation for a REST API in Go (using go-chi). Currently, I'm testing https://github.com/swaggo/swag/, but I'm uncertain if it's the optimal solution. What are your thoughts or recommendations?
- Como deixar o Swagger com tema dark mode usando Swaggo e Golang
-
Building RESTful API with Hexagonal Architecture in Go
Swaggo is a tool that creates Swagger documentation for Go APIs. It makes documenting API endpoints easier, helping developers understand and use the API.
-
go-ecommerce-microservices: A practical e-commerce microservices, built with cqrs, event sourcing, vertical slice architecture, event-driven architecture.
Some of the features: - ✅ Using Vertical Slice Architecture as a high level architecture - ✅ Using Event Driven Architecture on top of RabbitMQ Message Broker with a custom [Event Bus](pkg/messaging/bus/) - ✅ Using Event Sourcing in Audit Based services like [Orders Service](services/orders/) - ✅ Using CQRS Pattern and Mediator Patternon top of Go-MediatR library - ✅ Using Dependency Injection and Inversion of Controlon top of uber-go/fx library - ✅ Using RESTFul api with Echo framework and using swagger with swaggo/swag library - ✅ Using Postgres and EventStoreDB to write databases with fully supports transactions(ACID) - ✅ Using MongoDB and Elastic Search for read databases (NOSQL) - ✅ Using OpenTelemetry for collection Distributed Tracing with using Jaeger and Zipkin - ✅ Using OpenTelemetry for collection Metrics with using Prometheus and Grafana - ✅ Using Unit Test for testing small units with mocking dependent classes and using Mockery for mocking dependencies - ✅ Using End2End Test and Integration Test for testing features with all of their real dependeinces using docker containers (cleanup tests) and testcontainers-go library
- OpenAPI v4 Proposal
-
[Request] Library Recommendation for Auto Swagger/OpenAPIv3 Documentation
I used this the other day and found it very easy to set up: https://github.com/swaggo/swag
-
Public API documentation. What to use?
I use the fizz for developing my webservices + docs, it's smooth! There is swaggo but I don`t like it because the source code get dirty (lots of comments)
-
Any Working Example for Swagger integartion with golang?
You can use swaggo/swag with code annotations
-
Swagger codegen or custom tool
checkout swaggo/swag.
-
a tool for quickly creating web and microservice code
Documentation swagger
What are some alternatives?
GoSwagger - Swagger 2.0 implementation for go
L5-Swagger - OpenApi or Swagger integration to Laravel
gin-swagger - gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
fiber-swagger - fiber middleware to automatically generate RESTful API documentation with Swagger 2.0.
laminas-code - Extensions to the PHP Reflection API, static code scanning, and code generation
Nginx Proxy Manager - Docker container for managing Nginx proxy hosts with a simple, powerful interface
apiDoc - RESTful web API Documentation Generator.
echo-swagger - echo middleware to automatically generate RESTful API documentation with Swagger 2.0.
jaeger - CNCF Jaeger, a Distributed Tracing Platform
grpc-go - The Go language implementation of gRPC. HTTP/2 based RPC
uuid - Go package for UUIDs based on RFC 4122 and DCE 1.1: Authentication and Security Services.
validator - :100:Go Struct and Field validation, including Cross Field, Cross Struct, Map, Slice and Array diving