nodes / blueprint
This package is abandoned and no longer maintained.
No replacement package was suggested.
Forked version of API Blueprint documentation generator.
1.0.3
2017-09-15 14:21 UTC
Requires
- php: >=5.5.9
- doctrine/annotations: ~1.2
- illuminate/filesystem: ^5.1
- illuminate/support: ^5.1
- phpdocumentor/reflection-docblock: ^3.1
Requires (Dev)
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is not auto-updated.
Last update: 2022-02-01 12:59:20 UTC
README
This package generates a valid API Blueprint 1A document from a collection of classes.
Usage
Some index method phpdoc example:
<?php
/**
* Products
*
* @Resource("Products", uri="/products")
*/
class ProductsController extends ApiController
{
/**
* Products list
*
* Get current products list
*
* @Get("/")
* @Versions({"v1"})
* @Transaction({
* @Request(identifier="/?state=synced"),
* @Response(200, body={"data":{{"id":"rkoVJ7qa4Z6lzXdVnldgx9LmpBP0DQ3e","name":"Product name","status":"active"}},"meta":{"pagination":{"total":1,"count":1,"per_page":1,"current_page":1,"total_pages":1,"links":{}}}})
* })
* @Parameters({
* @Parameter("api_token", type="string", required=true, description="API Token", default=null),
* @Parameter("page", type="integer", required=false, description="Pagination page", default=1),
* @Parameter("state", type="string", required=false, description="Product status filter", default="synced", members={
* @Member(value="synced", description="Products synced"),
* @Member(value="pending", description="Products pending")
* })
* })
*/
public function index(Request $request)
{}
}
License
This package is licensed under the BSD 3-Clause license.