Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leodisarli committed Dec 4, 2023
1 parent c0a589a commit d16240f
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,28 +87,6 @@ Now you can access the health-check [http://localhost:8101](http://localhost:810
}
```

### Requests samples

Within the `/ops/requests` folder, you'll discover a collection of sample requests showcasing.

Requests have been meticulously documented in three different formats for your convenience:

1. Postman Collections
Files: `postman_collection.json` and `postman_environments.json`
Tool: Postman
These collections provide a comprehensive overview of the available API requests. Import them into Postman to explore and execute requests seamlessly.
<br>
2. Visual Studio Code (VSCode) REST Client Extension:
File: `requests.http`
Extension: [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)
Utilize the power of the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) Client extension in VSCode by opening the `requests.http` file. This extension allows you to send HTTP requests directly from your code editor, making it easy to interact with the API.
<br>
3. CURL Commands:
File: `requests.curl`
For those who prefer the command line, CURL commands are provided in the `requests.curl` file. Execute these commands in your terminal to interact with the API using the widely-used CURL tool.

Choose the documentation format that aligns with your preferred workflow and start seamlessly interacting with the API. If you encounter any issues or have questions, refer to the relevant documentation file for detailed information on each request.

### Creating your automatic crud domain

For create your brand new domain with a complete crud use the command:
Expand Down Expand Up @@ -138,6 +116,28 @@ This command will create a folder in `app/Domains`, new files in `routes`, `data
php artisan migration
```

### Requests samples

Within the `/ops/requests` folder, you'll discover a collection of sample requests showcasing.

Requests have been meticulously documented in three different formats for your convenience:

1. Postman Collections
Files: `postman_collection.json` and `postman_environments.json`
Tool: Postman
These collections provide a comprehensive overview of the available API requests. Import them into Postman to explore and execute requests seamlessly.
<br>
2. Visual Studio Code (VSCode) REST Client Extension:
File: `requests.http`
Extension: [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)
Utilize the power of the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) Client extension in VSCode by opening the `requests.http` file. This extension allows you to send HTTP requests directly from your code editor, making it easy to interact with the API.
<br>
3. CURL Commands:
File: `requests.curl`
For those who prefer the command line, CURL commands are provided in the `requests.curl` file. Execute these commands in your terminal to interact with the API using the widely-used CURL tool.

Choose the documentation format that aligns with your preferred workflow and start seamlessly interacting with the API.

### Ulid

For primary key value, this project using [Ulid](https://github.com/not-empty/ulid-php-lib) value, but you can pass other pattern in insert route if you prefer.
Expand Down

0 comments on commit d16240f

Please sign in to comment.