YGGverse/web-api
1
0
Fork 0
mirror of https://github.com/YGGverse/web-api.git synced 2025-08-30 07:42:03 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ghost 2023-12-16 15:31:15 +02:00
parent e06e5813f8
commit cd288a7f1f
1 changed files with 47 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -19,16 +19,59 @@ php -S localhost:8080
## Usage ## 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 ### 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
}
``` ```