Skip to content

Commit 57ef261

Browse files
authored
Improvement README
1 parent 8acf8eb commit 57ef261

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Full compatible smart structured API defined by schema.
1010
- Full compatible with Nette framework,
1111
- Inject dependencies by `@inject` annotation in public property.
1212

13-
How to install
14-
--------------
13+
📦 Installation & Basic Usage
14+
-----------------------------
1515

1616
This package can be installed using [PackageRegistrator](https://github.com/baraja-core/package-manager) which is also part of the Baraja [Sandbox](https://github.com/baraja-core/sandbox). If you are not using it, you have to install the package manually following this guide.
1717

@@ -20,11 +20,11 @@ A model configuration can be found in the `common.neon` file inside the root of
2020
To manually install the package call Composer and execute the following command:
2121

2222
```shell
23-
composer require baraja-core/structured-api
23+
$ composer require baraja-core/structured-api
2424
```
2525

26-
API endpoint
27-
------------
26+
🛠️ API endpoint
27+
---------------
2828

2929
API endpoint is simple class with action methods and dependencies. For best comfort please use your custom BaseEndpoint with declaring all required dependencies.
3030

@@ -35,10 +35,10 @@ Simple example:
3535

3636
declare(strict_types=1);
3737

38-
namespace Baraja\StructuredApi;
38+
namespace App\Model;
3939

4040

41-
class TestEndpoint extends BaseEndpoint
41+
final class MyAwesomeEndpoint extends BaseEndpoint
4242
{
4343

4444
/**
@@ -70,3 +70,17 @@ class TestEndpoint extends BaseEndpoint
7070
Method `actionDefault` is used for request in format `/api/v1/test` with query parameter `?hello=...`.
7171

7272
Method `postCreateUser` will be called by POST request with all data.
73+
74+
🗺️ Project endpoint documentation
75+
---------------------------------
76+
77+
When developing a real application, you will often need to pass work between the backend and the frontend.
78+
79+
To describe all endpoints, the package offers an optional extension that generates documentation automatically based on real code scanning.
80+
81+
Try the [Structured API Documentation](https://github.com/baraja-core/structured-api-doc).
82+
83+
📄 License
84+
-----------
85+
86+
`baraja-core/structured-api` is licensed under the MIT license. See the [LICENSE](https://github.com/baraja-core/structured-api/blob/master/LICENSE) file for more details.

0 commit comments

Comments
 (0)