Skip to content

Commit 2e764f1

Browse files
committed
add requests
1 parent 0b121a3 commit 2e764f1

File tree

5 files changed

+931
-6
lines changed

5 files changed

+931
-6
lines changed

README.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,6 @@ Now you can access the health-check [http://localhost:8101](http://localhost:810
8585
}
8686
```
8787

88-
### Requests samples
89-
90-
You can find a sample of requests you can do in the file `requests.http` (for the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension on VSCode) or using curl commands listed in the file `requests.curl`.
91-
92-
Not all requests are documented yet (Work in progress)
93-
9488
### Creating your automatic crud domain
9589

9690
For create your brand new domain with a complete crud use the command:
@@ -120,6 +114,38 @@ This command will create a folder in `app/Domains`, new files in `routes`, `data
120114
php artisan migration
121115
```
122116

117+
### Requests samples
118+
119+
Within the `/ops/requests` folder, you'll discover a collection of sample requests showcasing.
120+
121+
Requests have been meticulously documented in three different formats for your convenience:
122+
123+
1. Postman Collections
124+
125+
Files: `postman_collection.json` and `postman_environments.json`
126+
127+
Tool: Postman
128+
129+
These collections provide a comprehensive overview of the available API requests. Import them into Postman to explore and execute requests seamlessly.
130+
131+
132+
2. Visual Studio Code (VSCode) REST Client Extension:
133+
134+
File: `requests.http`
135+
136+
Extension: [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client)
137+
138+
With the extension installed in VSCode open 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.
139+
140+
141+
3. CURL Commands:
142+
143+
File: `requests.curl`
144+
145+
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.
146+
147+
Choose the documentation format that aligns with your preferred workflow and start seamlessly interacting with the API.
148+
123149
### Ulid
124150

125151
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.

0 commit comments

Comments
 (0)