https://github.com/osaguild/public-api
public api
https://github.com/osaguild/public-api
api aws messaging-api typescript
Last synced: about 1 month ago
JSON representation
public api
- Host: GitHub
- URL: https://github.com/osaguild/public-api
- Owner: osaguild
- Created: 2022-05-02T07:56:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T13:10:11.000Z (over 2 years ago)
- Last Synced: 2025-01-25T04:45:26.962Z (3 months ago)
- Topics: api, aws, messaging-api, typescript
- Language: TypeScript
- Homepage:
- Size: 219 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# public-api
public api for osaguild
## api lists
| api | description |
| :----------- | :----------------------------------- |
| taberogu api | api to get taberogu info by scraping |
## base url
| env | url |
| :-- | :--------------------------- |
| dev | https://api.dev.osaguild.com |
| prd | https://api.osaguild.com |
## api reference
### taberogu api
| service | endpoint | method | request data | response data | curl |
| :------- | :------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| taberogu | /v1/taberogu | get | ?prefecture=xxx&city=xxx&shopName=xxx | { "id": "1234", "url": "https://xxx", "star": "3.5", "unique": true } | curl 'https://api.dev.osaguild.com/v1/taberogu?prefecture=saitama&city=saitama&shopName=よし佳' |
| taberogu | /v1/taberogu/ranking | get | ?prefecture=xxx&city=xxx | [{ "id": "1234", "url": "https://xxx", "star": "3.5", "ranking": true }, ... ] | curl 'https://api.dev.osaguild.com/v1/taberogu/ranking?prefecture=saitama&city=saitama' |
| hook | /v1/hook | post | { "action": "completed", "workflow_run": { "name": "scraping dev", "path": ".github/workflows/scraping-dev.yaml", "status": "completed", "conclusion": "success" } } | "success" | curl -X POST -H "Content-Type: application/json" -d '{ "action": "completed", "workflow_run": { "name": "scraping dev", "path": ".github/workflows/scraping-dev.yaml", "status": "completed", "conclusion": "success" } }' 'https://api.dev.osaguild.com/v1/hook' |