mirror of
https://github.com/YGGverse/web-api.git
synced 2025-08-29 15:22:04 +00:00
update readme
This commit is contained in:
parent
e06e5813f8
commit
cd288a7f1f
51
README.md
51
README.md
@ -19,16 +19,59 @@ php -S localhost:8080
|
||||
|
||||
## Usage
|
||||
|
||||
### Socket
|
||||
|
||||
Check socket
|
||||
|
||||
#### Usage
|
||||
|
||||
* `port` required
|
||||
* `host` optional, name, IPv4 or IPv6 (`REMOTE_ADDR` by default)
|
||||
|
||||
```
|
||||
GET socket.php?port=80&host=php.net
|
||||
```
|
||||
|
||||
##### Response
|
||||
|
||||
```
|
||||
JSON
|
||||
{
|
||||
status: bool
|
||||
}
|
||||
```
|
||||
|
||||
### Dig
|
||||
|
||||
#### Single record
|
||||
Show host records
|
||||
|
||||
#### Usage
|
||||
|
||||
* `name` required host name, IPv4 or IPv6
|
||||
* `record` required if `records` not provided
|
||||
* `records` required if `record` not provided
|
||||
+ [x] A
|
||||
+ [x] AAAA
|
||||
+ [ ] SRV #1
|
||||
|
||||
##### Single record
|
||||
|
||||
```
|
||||
dig.php?name=php.net&record=A
|
||||
GET dig.php?name=php.net&record=A
|
||||
```
|
||||
|
||||
#### Multiple records
|
||||
##### Multiple records
|
||||
|
||||
```
|
||||
dig.php?name=php.net&records[]=A&records[]=AAAA
|
||||
GET dig.php?name=php.net&records[]=A&records[]=AAAA
|
||||
```
|
||||
|
||||
##### Response
|
||||
|
||||
```
|
||||
JSON
|
||||
{
|
||||
status: bool
|
||||
records: array
|
||||
}
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user