管理

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

• 创建OpenAPI文档

• 验证OpenAPI文档

• 设置系统环境变量

创建OpenAPI文档

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

要生成OpenAPI文档，请运行以下命令：

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

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

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

属性显式写入文件。 --output-file 选项：

pygeoapi openapi generate /path/to/my-pygeoapi-config.yml --output-file /path/to/my-pygeoapi-openapi.yml

要将OpenAPI文档生成为JSON，请运行：

pygeoapi openapi generate /path/to/my-pygeoapi-config.yml -f json > /path/to/my-pygeoapi-openapi.json

备注

生成为YAML还是JSON？如果您的OpenAPI YAML定义呈现为JSON的速度较慢，则将其另存为JSON到磁盘将有助于提高运行时的性能。

备注

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

参见

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

正在验证OpenAPI文档

为确保您的OpenAPI文档有效，pyGeoapi提供了一个验证实用程序，可按如下方式运行：

pygeoapi openapi validate /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
# or if OpenAPI JSON
export PYGEOAPI_OPENAPI=/path/to/my-pygeoapi-openapi.json

在Windows中：

set PYGEOAPI_CONFIG=/path/to/my-pygeoapi-config.yml
set PYGEOAPI_OPENAPI=/path/to/my-pygeoapi-openapi.yml
# or if OpenAPI JSON
set PYGEOAPI_OPENAPI=/path/to/my-pygeoapi-openapi.json

总结

此时，您就可以运行服务了。走吧！