LSST数据管理广场微服务工具
sqre-apikit的Python项目详细描述
[![构建状态](https://travis-ci.org/lsst-sqre/sqre-apikit.svg?branch=master)(https://travis ci.org/lsst sqre/sqre-apikit)
sqre-apikit
该路由必须提供有关服务的适当
元数据。
并且必须包含以下字段:
`name`:`str`
`version`:`str`
`repository`:`str`
`description`:`str`
`api-version`:`str`
`auth`:`str`
`name`、`version`、`api-version`和`description`这些字段是任意的,尽管强烈鼓励进行语义版本控制,而且
api版本应该反映
使用中的“api.lsst.codes”api的版本(当前为“1.0”,文档待定)。
auth必须是“none”、“basic”或“bitly proxy”之一。它代表了microservice向github进行身份验证的方式:要么它不需要,它使用带有用户名和服务令牌的http basic auth,要么它使用带有用户名、密码的bitly oauth2代理,
和代理启动-oauth2端点。
一个模块,“APIKIT”,包含三个BR/>函数,“SETIFLASKY元数据”,“AddiMeta AddiaTrad”和“BR/>‘ReTurnEngult'”,以及一个类“ApIFLASK`.BR/>< BR/>”SETH-FLASKYMPEGETATION在现有的烧瓶应用程序上设置元数据,并添加了
元数据路由。“AddiMeta AddioRead”被设计为将路由列表中的每个组件添加到
到现有的烧瓶应用程序中。
‘ReReTunMeta’返回元数据的JSON表示,用于
服务。
BR/>“ApIFLASK”类创建了一个子类的实例:“烧瓶。烧瓶”BR/>,它已经添加了元数据和路由。在其中烘焙。
该类附带了一个方法“add_route_prefix”,它在另一个路由下面添加了元数据路由。例如,如果将微服务连接到kubernetes及其入口资源(这些资源提供路由但不重写),这将非常有用。
你可以用
``bash
pip-install sqre-apikit
``````
这也将安装依赖关系`烧瓶`.
` ` ` apikit.set_flask_metadata()`
``python
import-apikit
import-apikit
app=flask.flask
``````````````````` bash
` ` ` ` ` ` ` ` ` ` `“
apikit.set_flask_元数据(app,
version=“0.0.1”,
repository=“http://example.repo”,
description=“hello world app”)
````
``python
`导入apikit
app=apikit.apiflask(name=“hello”,
version=“0.0.1”,
repository=“http://example.repo”,
description=“hello world app”)
````
venv/bin/activate
pip install-r requirements.txt
python setup.py develop
```
可以使用[py test]运行测试(http://pytest.org/latest/):
```bash
``py.tests
```
sqre-apikit
该路由必须提供有关服务的适当
元数据。
并且必须包含以下字段:
`name`:`str`
`version`:`str`
`repository`:`str`
`description`:`str`
`api-version`:`str`
`auth`:`str`
`name`、`version`、`api-version`和`description`这些字段是任意的,尽管强烈鼓励进行语义版本控制,而且
api版本应该反映
使用中的“api.lsst.codes”api的版本(当前为“1.0”,文档待定)。
auth必须是“none”、“basic”或“bitly proxy”之一。它代表了microservice向github进行身份验证的方式:要么它不需要,它使用带有用户名和服务令牌的http basic auth,要么它使用带有用户名、密码的bitly oauth2代理,
和代理启动-oauth2端点。
一个模块,“APIKIT”,包含三个BR/>函数,“SETIFLASKY元数据”,“AddiMeta AddiaTrad”和“BR/>‘ReTurnEngult'”,以及一个类“ApIFLASK`.BR/>< BR/>”SETH-FLASKYMPEGETATION在现有的烧瓶应用程序上设置元数据,并添加了
元数据路由。“AddiMeta AddioRead”被设计为将路由列表中的每个组件添加到
到现有的烧瓶应用程序中。
‘ReReTunMeta’返回元数据的JSON表示,用于
服务。
BR/>“ApIFLASK”类创建了一个子类的实例:“烧瓶。烧瓶”BR/>,它已经添加了元数据和路由。在其中烘焙。
该类附带了一个方法“add_route_prefix”,它在另一个路由下面添加了元数据路由。例如,如果将微服务连接到kubernetes及其入口资源(这些资源提供路由但不重写),这将非常有用。
你可以用
``bash
pip-install sqre-apikit
``````
这也将安装依赖关系`烧瓶`.
` ` ` apikit.set_flask_metadata()`
``python
import-apikit
import-apikit
app=flask.flask
``````````````````` bash
` ` ` ` ` ` ` ` ` ` `“
apikit.set_flask_元数据(app,
version=“0.0.1”,
repository=“http://example.repo”,
description=“hello world app”)
````
``python
`导入apikit
app=apikit.apiflask(name=“hello”,
version=“0.0.1”,
repository=“http://example.repo”,
description=“hello world app”)
````
venv/bin/activate
pip install-r requirements.txt
python setup.py develop
```
可以使用[py test]运行测试(http://pytest.org/latest/):
```bash
``py.tests
```