管理

现在已经安装了pygeoapi并设置了基本配置,现在是时候在启动服务器之前完成所需的管理步骤了。其余步骤包括:

  • 创建OpenAPI文档

  • 设置系统环境变量

创建OpenAPI文档

OpenAPI文档是从pygeoapi配置生成的YAML配置,它描述了服务器信息、端点和参数。

要生成OpenAPI文档,请运行以下命令:

pygeoapi generate-openapi-document -c /path/to/my-pygeoapi-config.yml

这将把OpenAPI文档作为YAML转储到系统的 stdout . 要保存到磁盘上的文件,请运行:

pygeoapi generate-openapi-document -c /path/to/my-pygeoapi-config.yml > /path/to/my-pygeoapi-openapi.yml

注解

OpenAPI文档提供有关查询参数、数据集属性名称及其数据类型的详细信息。每当您更改pygeoapi配置时,请始终刷新附带的OpenAPI文档。

参见

开放应用程序接口 有关pygeoapi的OpenAPI支持的更多信息

验证配置文件

请确保您可以使用下面的YAML或YAML验证程序正确格式化了以下配置:

python -c 'import yaml, sys; yaml.safe_load(sys.stdin)' < /path/to/my-pygeoapi-config.yml
python -c 'import yaml, sys; yaml.safe_load(sys.stdin)' < /path/to/my-pygeoapi-openapi.yml

设置系统环境变量

现在,让我们设置系统环境变量。

在UNIX中:

export PYGEOAPI_CONFIG=/path/to/my-pygeoapi-config.yml
export PYGEOAPI_OPENAPI=/path/to/my-pygeoapi-openapi.yml

在Windows中:

set PYGEOAPI_CONFIG=/path/to/my-pygeoapi-config.yml
set PYGEOAPI_OPENAPI=/path/to/my-pygeoapi-openapi.yml

总结

此时,您就可以运行服务了。走吧!