Skip to content

Commit d4503ea

Browse files
committed
readme updated
1 parent b6aef2b commit d4503ea

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
# Extended Api Doc Bundle #
22

3+
An extension for `nelmio/api-doc-bundle` that improves the sorting of endpoints by tags and provides minor stylistic corrections to the original Nelmio view.
4+
35
## Installation
46

7+
Required bundles:
8+
9+
```bash
10+
composer require symfony/asset
11+
composer require symfony/twig-bundle
12+
composer require nelmio/api-doc-bundle
13+
composer require pbaszak/extended-api-doc-bundle
14+
```
15+
16+
Routing Registration:
17+
18+
- /api/doc
19+
- /api/doc.json
20+
- /api/doc.yaml
21+
522
```yaml
623
# config/routes.yaml
724
...
825
extended_api_doc:
926
resource: '@ExtendedApiDocBundle/Resources/routes/*'
1027
```
1128
29+
Setup metainfo:
30+
1231
```yaml
1332
# config/packages/nelmio_api_doc.yaml
1433
parameters:
@@ -30,6 +49,8 @@ nelmio_api_doc:
3049
3150
## Usage
3251
52+
Just open `/api/doc` path on Your server and enjoy!
53+
3354
## Development
3455

3556
### How to start

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "pbaszak/extended-api-doc-bundle",
33
"title": "PBaszak Extended Api Doc Bundle",
4-
"description": "PBaszak Extended Api Doc Bundle - Library",
4+
"description": "An extension for `nelmio/api-doc-bundle` that improves the sorting of endpoints by tags and provides minor stylistic corrections to the original Nelmio view.",
55
"type": "symfony-bundle",
66
"license": "MIT",
77
"authors": [

0 commit comments

Comments
 (0)