Download the PHP package ehyiah/apidoc-bundle without Composer
On this page you can find all versions of the php package ehyiah/apidoc-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ehyiah/apidoc-bundle
More information about ehyiah/apidoc-bundle
Files in ehyiah/apidoc-bundle
Package apidoc-bundle
Short Description Symfony Bundle to deal with api doc using SwaggerUI and yaml/yml files
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package apidoc-bundle
ApiDocBundle
Symfony Bundle to deal with api doc using SwaggerUI and yaml/yml files without annotations/attributes.
If you just want to write simple yaml/yml files to create your api doc, this bundle is made for you. Install, create your api doc with yaml/yml files in the source directory, it's done ! You can create as many files as you want and organize them in subdirectory as well to your needs.
to write files Check the openapi specifications OpenApi
The bundle use the Swagger UI to render the final result.
You will find some exemple after the bundle is installed in the default directory /src/Swagger.
Installation
Installation for usage purpose
This bundle does not have a flex recipe (at the moment), so if you want an "auto-installation" :
On the project you want to use this bundle: If you want the project to install every files automatically add these lines
-
On composer.json, please add these lines :
- Run
composer require ehyiah/apidoc-bundle
On a composer remove, the files you have created will not be deleted.
Installation for development purpose on this bundle
- clone this project wherever you want.
-
On the project you want to use this bundle:
-
On composer.json, please add these lines :
- Run
composer require ehyiah/apidoc-bundle:@dev
-
Usage
-
In your .env file, update the site_url variable to use it in your Swagger UI interface.
-
In the src/Swagger, just add the yaml files that you want to be parsed and displayed on the Swagger UI interface. the directory can be modified in the .env file with the source_path variable.
- the default route is ehyiah/api/doc exemple : localhost/ehyiah/api/doc, you can modify this route in the config/routes/ehyiah_api_doc.yaml file.
Recommended directory structure
If you want to use generation commands (see below) but do not want to use Auto-generated components names,
you will have to check and update all $ref used in the generated yaml/yml files by the commands.
exemple: You got a DTO class called MyDto, a schema named MyDto will be created and used everywhere a reference to this class is created.
So if you want to call your component MyAwesomeDto instad of default name, you will have to update the reference ($ref) in every file.
=> is the env variable used as source directory for your api doc default is
| Type of Components | Default directory | |
|---|---|---|
| Schemas | {SOURCE_PATH}/schemas | |
Generating ApiDoc Components
Some commands are included in the bundle to pre-generate components. You will probably have to edit the generated files or at least check if everything is okay.
| Command | Arguments | Options | Generation type |
|---|---|---|---|
| apidocbundle:component:schema | pass the FQCN of the php class you wish (exemple: a DTO, an Entity, any POPO) | --output (-o) specify a custom output directory to dump the generated file from the kernel_project_dir | Generate a schema |
| apidocbundle:component:body | pass the FQCN of the php class you wish (exemple: a DTO, an Entity, any POPO or a FormType) | --reference (-r) specify if a reference must be used instead of regenerating a new schema in the requestBody | Generate a RequestBody |
ApiDoc Linting
If needed, there is a command to generate your apidoc into a single file in yaml or json format.
You can use this command for exemple to generate a yaml file and use vacuum to lint your file.
All versions of apidoc-bundle with dependencies
doctrine/orm Version ^2.10
symfony/property-access Version ^6.1|^7.0
symfony/monolog-bundle Version ^3.1
symfony/yaml Version ^6.1|^7.0
symfony/finder Version ^6.1|^7.0
symfony/dependency-injection Version ^6.1|^7.0
symfony/property-info Version ^6.1|^7.0
symfony/form Version ^6.1|^7.0