Open Api

OpenAPI Specification (OAS) allows both humans and computers to discover the capabilities of the service through source code, documentation, or network traffic inspection and It defines a standard, language-independent interface to RESTful APIs that allows When defined correctly, a consumer can understand and interact with the remote service with a minimal amount of application logic.

An OpenAPI definition then generates documentation tools to display the API, code to create servers and clients in various programming languages It can be used by tools, testing tools, and many other use cases.

Swagger - PHP

The Swagger - php library allows you to create OpenAPI documentation for your RESTful API. Swagger-php comes installed in the package.json file in your Olobase project. You should use composer swagger to create/update documentation with pre-existing swagger schemas.

cd /var/www/olobase-demo-php
composer swagger

output:

> vendor/bin/openapi /var/www/olobase-demo-php -e vendor -o public/swagger/web/swagger.json

To view the documentation you created, you must visit http://example.com/swagger/web as follows.

http://demo.local/swagger/web/