-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
faed8a7
commit 29010e7
Showing
11 changed files
with
1,086 additions
and
212 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,71 @@ | ||
| # Simple HTTP API convert longitude&latitude to timezone name | ||
|
|
||
| > **Note**: It's designed as a debugger tool for package | ||
| > [tzf](https://github.com/ringsaturn/tzf), not production ready. | ||
| ```bash | ||
| go install github.com/ringsaturn/tzf-server@latest | ||
|
|
||
| # check args | ||
| tzf-server --help | ||
|
|
||
| # start server | ||
| tzf-server | ||
| # start general server | ||
| ./tzf-server | ||
|
|
||
| # start FuzzyFinder based server | ||
| ./tzf-server -type 1 | ||
| ``` | ||
|
|
||
| ## Web Pages | ||
|
|
||
| ### All supported timezone names | ||
|
|
||
| [`http://localhost:8080/tzs/list/page`](http://localhost:8080/tzs/list/page) | ||
|
|
||
| ## API | ||
|
|
||
| ### Lookup Location's timezone | ||
|
|
||
| ```bash | ||
| curl "http://localhost:8080/tz?lng=116.3883&lat=39.9289" | ||
| ``` | ||
|
|
||
| Output: | ||
|
|
||
| ```json | ||
| { | ||
| "timezone": "Asia/Shanghai" | ||
| } | ||
| ``` | ||
|
|
||
| Example links: | ||
| ### Lookup Location's timezones | ||
|
|
||
| - Query by location [`http://localhost:8080/tz?lng=-0.1276&lat=51.5073`](http://localhost:8080/tz?lng=-0.1276&lat=51.5073) | ||
| - Query by offset [`http://localhost:8080/tz/offset?offset=0`](http://localhost:8080/tz/offset?offset=0) | ||
| - Query by name [`http://localhost:8080/info?name=Etc/GMT-12`](http://localhost:8080/info?name=Etc/GMT-12) | ||
| ```bash | ||
| curl "http://localhost:8080/tzs?lng=87.6168&lat=43.8254" | ||
| ``` | ||
|
|
||
| Output: | ||
|
|
||
| ```json | ||
| { | ||
| "timezones": ["Asia/Shanghai", "Asia/Urumqi"] | ||
| } | ||
| ``` | ||
|
|
||
| ### All supported timezone names | ||
|
|
||
| ```bash | ||
| curl "http://localhost:8080/tzs/list" | ||
| ``` | ||
|
|
||
| Output: | ||
|
|
||
| ```json | ||
| { | ||
| "timezones": [ | ||
| "Africa/Abidjan", | ||
| // ... | ||
| "Pacific/Tongatapu" | ||
| ] | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.