Skip to content

Commit 6f85807

Browse files
committed
update readme
1 parent f0ee71e commit 6f85807

File tree

1 file changed

+42
-34
lines changed

1 file changed

+42
-34
lines changed

README.md

+42-34
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1+
# Laravel Api Response
2+
Unification of API responses for Laravel projects inspired by telegram api responses.
3+
14
<p align="center">
25
<img src="https://raw.githubusercontent.com/kolirt/laravel-api-response/v3/cover.png">
36
</p>
47

58

6-
# Laravel Api Response
7-
Unification of API responses for Laravel projects inspired by telegram api responses.
8-
9-
10-
# Structure
9+
## Structure
1110
- [Getting started](#getting-started)
1211
- [Requirements](#requirements)
1312
- [Installation](#installation)
@@ -34,26 +33,26 @@ Unification of API responses for Laravel projects inspired by telegram api respo
3433
</a>
3534

3635

37-
# Getting started
36+
## Getting started
3837

39-
## Requirements
38+
### Requirements
4039
- PHP >= 8.1
4140
- Laravel >= 10
4241

4342
For lesser versions of Laravel or PHP, use the [v2](https://github.com/kolirt/laravel-api-response/tree/v2)
4443

4544

46-
## Installation
45+
### Installation
4746
```bash
4847
composer require kolirt/laravel-api-response
4948
```
5049

5150

52-
# Usage
51+
## Usage
5352

54-
## Example
53+
### Example
5554

56-
### Error response
55+
#### Error response
5756
```php
5857
return api()
5958
->error()
@@ -86,7 +85,7 @@ return api()
8685
```
8786

8887

89-
### Success response
88+
#### Success response
9089
```php
9190
return api()
9291
->success()
@@ -118,40 +117,45 @@ return api()
118117
```
119118

120119

121-
## Methods
120+
### Methods
121+
122+
#### `error`
123+
Mark response as error
122124

123-
### error
124-
Mark response as error.
125125
```php
126126
return api()->error();
127127
```
128128

129129

130-
### success
131-
Mark response as success.
130+
#### `success`
131+
Mark response as success
132+
132133
```php
133134
return api()->success();
134135
```
135136

136137

137-
### setCode
138-
Set specific code to response. Available [codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).
138+
#### `setCode`
139+
Set specific code to response. Available [codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)
140+
139141
```php
140142
return api()->setCode($code);
141143
```
142144

143145

144-
### setDescription
145-
Add description to response.
146+
#### `setDescription`
147+
Add description to response
148+
146149
```php
147150
return api()->setDescription(['Description #1', 'Description #2']);
148151
// or
149152
return api()->setDescription('Description');
150153
```
151154

152155

153-
### setErrors
154-
Add errors to response.
156+
#### `setErrors`
157+
Add errors to response
158+
155159
```php
156160
return api()->setErrors([
157161
'first_name' => 'Error message',
@@ -160,43 +164,47 @@ return api()->setErrors([
160164
```
161165

162166

163-
### abort
164-
Abort response with error.
167+
#### `abort`
168+
Abort response with error
169+
165170
```php
166171
return api()->abort('Error message', 400);
167172
```
168173

169174

170-
### cookie
171-
Add cookie to response.
175+
#### `cookie`
176+
Add cookie to response
177+
172178
```php
173179
return api()->cookie(cookie('token', 'asdsadsadas', 60 * 3));
174180
```
175181

176182

177-
### setData
178-
Add data to response.
183+
#### `setData`
184+
Add data to response
185+
179186
```php
180187
return api()->setData(['Data #1', 'Data #2']);
181188
// or
182189
return api()->setData('Data');
183190
```
184191

185192

186-
### render
187-
Render response.
193+
#### `render`
194+
Render response
195+
188196
```php
189197
return api()->render();
190198
```
191199

192200

193-
# FAQ
201+
## FAQ
194202
Check closed [issues](https://github.com/kolirt/laravel-api-response/issues) to get answers for most asked questions
195203

196204

197-
# License
205+
## License
198206
[MIT](LICENSE.txt)
199207

200208

201-
# Other packages
209+
## Other packages
202210
Check out my other packages on my [GitHub profile](https://github.com/kolirt)

0 commit comments

Comments
 (0)