Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
疯人忠
Cvat
提交
e78bd06d
C
Cvat
项目概览
疯人忠
/
Cvat
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
C
Cvat
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
e78bd06d
编写于
6月 10, 2021
作者:
T
Timur Osmanov
提交者:
GitHub
6月 10, 2021
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add REST API guide in documentation (#3307)
* add rest api guide * fix linter error
上级
6729d1a1
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
44 addition
and
10 deletion
+44
-10
README.md
README.md
+1
-10
site/content/en/docs/for-developers/REST_API_guide.md
site/content/en/docs/for-developers/REST_API_guide.md
+43
-0
未找到文件。
README.md
浏览文件 @
e78bd06d
...
...
@@ -20,7 +20,7 @@ annotation team. Try it online [cvat.org](https://cvat.org).
-
[
Contributing
](
https://openvinotoolkit.github.io/cvat/docs/for-developers/contributing/
)
-
[
Installation guide
](
https://openvinotoolkit.github.io/cvat/docs/for-users/installation/
)
-
[
User's guide
](
https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/
)
-
[
Django REST API documentation
](
#rest-api
)
-
[
Django REST API documentation
](
https://openvinotoolkit.github.io/cvat/docs/for-developers/rest_api_guide/
)
-
[
Datumaro dataset framework
](
https://github.com/openvinotoolkit/datumaro/blob/develop/README.md
)
-
[
Command line interface
](
https://openvinotoolkit.github.io/cvat/docs/for-developers/cli/
)
-
[
XML annotation format
](
https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/
)
...
...
@@ -116,15 +116,6 @@ Prebuilt docker images for CVAT releases are available on Docker Hub:
-
[
cvat_server
](
https://hub.docker.com/r/openvino/cvat_server
)
-
[
cvat_ui
](
https://hub.docker.com/r/openvino/cvat_ui
)
## REST API
Automatically generated Swagger documentation for Django REST API is available
on
`<cvat_origin>/api/swagger`
(default:
`localhost:8080/api/swagger`
).
Swagger documentation is visible on allowed hosts, Update environment
variable in docker-compose.yml file with cvat hosted machine IP or domain
name. Example -
`ALLOWED_HOSTS: 'localhost, 127.0.0.1'`
.
## LICENSE
Code released under the
[
MIT License
](
https://opensource.org/licenses/MIT
)
.
...
...
site/content/en/docs/for-developers/REST_API_guide.md
0 → 100644
浏览文件 @
e78bd06d
---
title
:
'
REST
API
guide'
linkTitle
:
'
REST
API'
weight
:
12
---
To access swagger documentation you need to be authorized.
Automatically generated Swagger documentation for Django REST API is available
on
`<cvat_origin>/api/swagger`
(default:
`localhost:8080/api/swagger`
).
Swagger documentation is visible on allowed hosts, Update environment
variable in docker-compose.yml file with cvat hosted machine IP or domain
name. Example -
`ALLOWED_HOSTS: 'localhost, 127.0.0.1'`
.
Make a request to a resource stored on a server and the server will respond with the requested information.
The HTTP protocol is used to transport a data.
Requests are divided into groups:
-
`auth`
- user authorization queries
-
`comments`
- requests to post/delete comments to issues
-
`issues`
- update, delete and view problem comments
-
`jobs`
-requests to manage the job
-
`lambda`
- requests to work with lambda function
-
`projects`
- project management queries
-
`restrictions`
- requests for restrictions
-
`reviews`
-adding and removing the review of the job
-
`server`
- server information requests
-
`tasks`
- requests to manage tasks
-
`users`
- user management queries
Besides it contains
`Models`
.
Models - the data type is described using a
[
schema object
](
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#schemaObject
)
.
Each group contains queries related to a different types of HTTP methods such as:
`GET`
,
`POST`
,
`PATCH`
,
`DELETE`
, etc.
Different methods are highlighted in different color. Each item has a name and description.
Clicking on an element opens a form with a name, description and settings input field or an example of json values.
To find out more, read
[
swagger specification
](
https://swagger.io/docs/specification/about/
)
.
To try to send a request, click
`Try it now `
and type
`Execute`
.
You'll get a response in the form of
[
`Curl`
](
https://curl.se/
)
,
`Request URL`
and
`Server response`
.
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录