shivammathur / countrycity
API 获取所有国家和国家内的所有城市。
3.1.3
2021-09-08 17:31 UTC
Requires
- php: >=7.4
- ext-iconv: *
- ext-json: *
- ext-mbstring: *
- halaxa/json-machine: *
- slim/http-cache: ^0.4.0
- slim/php-view: ^3.0
- slim/slim: ^3.12
- symfony/event-dispatcher: *
- symfony/http-kernel: *
- symfony/process: *
Requires (Dev)
- nikic/php-parser: *
- phpunit/php-code-coverage: dev-master
- phpunit/phpunit: dev-master
- sebastian/global-state: dev-master
- sebastian/type: dev-master
- squizlabs/php_codesniffer: *
Suggests
- ext-pcov: *
README
地理数据 API 获取世界各国的国家和城市列表。这可以嵌入到表单的国家和城市选择下拉菜单中。您可以在select2实现中找到这里。该实现的代码位于example
目录。
⚡ 安装 CountryCity API
- 确保您有 PHP 7.4 或更高版本。
$ php -v
- 使用以下命令使用 composer 下载此 API。
composer global require shivammathur/countrycity "dev-main"
- 然后执行以下命令安装 API。
composer create-project shivammathur/countrycity countrycity "dev-main" --prefer-dist
- 您已设置完毕,现在可以使用此 API。
#️⃣ API 端点
所有 API 响应都是 json
格式。
- 获取所有国家
/countries
# Without URL Rewriting
/index.php/countries
- 获取包含搜索关键字的所有国家
/countries/{search_keyword}
# Without URL Rewriting
/index.php/countries/{search_keyword}
- 获取一个国家内的所有城市
/cities/{country}
# Without URL Rewriting
/index.php/cities/{country}
- 获取一个国家内包含搜索关键字的所有城市
/cities/{country}/{search_keyword}
# Without URL Rewriting
/index.php/cities/{country}/{search_keyword}
✨ Rest API 功能
- 使用 Slim 微框架构建。
- 启用了以下头部的缓存
- ETag
- Expires
- Last-Modified
- 快速且轻量级的 API
- PSR 7 兼容
- CORS 中间件
☁️ 主机配置
如果您想在自己的服务器上托管此服务,请参阅配置说明。
🔧 错误格式
如果 API 出现错误,您将收到以 json
格式的错误响应。
{"error":"true", "message": "error message here"}
🚨 测试
$ vendor/bin/phpunit --configuration phpunit.xml.dist
📜 许可证
本项目中的脚本和文档均根据MIT 许可证发布。本项目有多个依赖项,其许可证可以在各自的存储库中找到。
👍 贡献
欢迎贡献!请参阅贡献指南。
💖 支持此项目
- 请为项目加星并与社区分享。
- 通过GitHub 赞助支持我的工作。