io.github.xezzon:zeroweb-service-open

10.1. 添加第三方应用

URL: http://127.0.0.1/third-party-app

Type: POST

Author: xezzon

Content-Type: application/json

Description: 添加第三方应用

Body-parameters:

Parameter	Type	Description	Required	Since
name	string	第三方应用名称	false	-

Parameter

Type

Description

Required

Since

name

string

第三方应用名称

false

-

Request-example:

curl -X POST -H "Content-Type: application/json" -i 'http://127.0.0.1/third-party-app' --data '{
  "name": ""
}'

Response-fields:

Field	Type	Description	Since
id	string	第三方应用标识	-
secretKey	string	第三方应用密钥	-

Field

Type

Description

Since

id

string

第三方应用标识

-

secretKey

string

第三方应用密钥

-

Response-example:

{
  "id": "",
  "secretKey": ""
}

10.2. 获取当前用户的所有第三方应用列表

URL: http://127.0.0.1/third-party-app/mine

Type: GET

Author: xezzon

Content-Type: application/x-www-form-urlencoded

Description: 获取当前用户的所有第三方应用列表

Query-parameters:

Parameter	Type	Description	Required	Since
top	int32	No comments found.	false	-
skip	int32	No comments found.	false	-

Parameter

Type

Description

Required

Since

top

int32

No comments found.

false

-

skip

int32

No comments found.

false

-

Request-example:

curl -X GET -i 'http://127.0.0.1/third-party-app/mine?top=0&skip=0'

Response-fields:

Field	Type	Description	Since
totalPages	int32	No comments found.	-
totalElements	int64	No comments found.	-
pageable	object	No comments found.	-
└─pageSize	int32	No comments found.	-
└─pageNumber	int32	No comments found.	-
└─paged	boolean	No comments found.	-
└─unpaged	boolean	No comments found.	-
└─offset	int64	No comments found.	-
└─sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
numberOfElements	int32	No comments found.	-
first	boolean	No comments found.	-
last	boolean	No comments found.	-
size	int32	No comments found.	-
content	array	No comments found.	-
└─id	string	第三方应用标识	-
└─name	string	第三方应用名称	-
└─ownerId	string	第三方应用所有者标识	-
└─createTime	string	创建时间	-
number	int32	No comments found.	-
sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
empty	boolean	No comments found.	-

Field

Type

Description

Since

totalPages

int32

No comments found.

-

totalElements

int64

No comments found.

-

pageable

object

No comments found.

-

└─pageSize

int32

No comments found.

-

└─pageNumber

int32

No comments found.

-

└─paged

boolean

No comments found.

-

└─unpaged

boolean

No comments found.

-

└─offset

int64

No comments found.

-

└─sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

numberOfElements

int32

No comments found.

-

first

boolean

No comments found.

-

last

boolean

No comments found.

-

size

int32

No comments found.

-

content

array

No comments found.

-

└─id

string

第三方应用标识

-

└─name

string

第三方应用名称

-

└─ownerId

string

第三方应用所有者标识

-

└─createTime

string

创建时间

-

number

int32

No comments found.

-

sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

empty

boolean

No comments found.

-

Response-example:

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageSize": 0,
    "pageNumber": 0,
    "paged": true,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "empty": true,
      "orders": [
        {
          "object": "any object"
        }
      ]
    }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "id": "",
      "name": "",
      "ownerId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "orders": [
      {
        "object": "any object"
      }
    ]
  },
  "empty": true
}

10.3. 查询所有第三方应用列表

URL: http://127.0.0.1/third-party-app

Type: GET

Author: xezzon

Content-Type: application/x-www-form-urlencoded

Description: 查询所有第三方应用列表

Query-parameters:

Parameter	Type	Description	Required	Since
top	int32	No comments found.	false	-
skip	int32	No comments found.	false	-

Parameter

Type

Description

Required

Since

top

int32

No comments found.

false

-

skip

int32

No comments found.

false

-

Request-example:

curl -X GET -i 'http://127.0.0.1/third-party-app?top=0&skip=0'

Response-fields:

Field	Type	Description	Since
totalPages	int32	No comments found.	-
totalElements	int64	No comments found.	-
pageable	object	No comments found.	-
└─pageSize	int32	No comments found.	-
└─pageNumber	int32	No comments found.	-
└─paged	boolean	No comments found.	-
└─unpaged	boolean	No comments found.	-
└─offset	int64	No comments found.	-
└─sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
numberOfElements	int32	No comments found.	-
first	boolean	No comments found.	-
last	boolean	No comments found.	-
size	int32	No comments found.	-
content	array	No comments found.	-
└─id	string	第三方应用标识	-
└─name	string	第三方应用名称	-
└─ownerId	string	第三方应用所有者标识	-
└─createTime	string	创建时间	-
number	int32	No comments found.	-
sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
empty	boolean	No comments found.	-

Field

Type

Description

Since

totalPages

int32

No comments found.

-

totalElements

int64

No comments found.

-

pageable

object

No comments found.

-

└─pageSize

int32

No comments found.

-

└─pageNumber

int32

No comments found.

-

└─paged

boolean

No comments found.

-

└─unpaged

boolean

No comments found.

-

└─offset

int64

No comments found.

-

└─sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

numberOfElements

int32

No comments found.

-

first

boolean

No comments found.

-

last

boolean

No comments found.

-

size

int32

No comments found.

-

content

array

No comments found.

-

└─id

string

第三方应用标识

-

└─name

string

第三方应用名称

-

└─ownerId

string

第三方应用所有者标识

-

└─createTime

string

创建时间

-

number

int32

No comments found.

-

sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

empty

boolean

No comments found.

-

Response-example:

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageSize": 0,
    "pageNumber": 0,
    "paged": true,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "empty": true,
      "orders": [
        {
          "object": "any object"
        }
      ]
    }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "id": "",
      "name": "",
      "ownerId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss"
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "orders": [
      {
        "object": "any object"
      }
    ]
  },
  "empty": true
}

10.4. 查询所有已发布的对外接口以及指定第三方应用的订阅情况

URL: http://127.0.0.1/third-party-app/{appId}/subscription

Type: GET

Author: xezzon

Content-Type: application/x-www-form-urlencoded

Description: 查询所有已发布的对外接口以及指定第三方应用的订阅情况

Path-parameters:

Parameter	Type	Description	Required	Since
appId	string	第三方应用ID	true	-

Parameter

Type

Description

Required

Since

appId

string

第三方应用ID

true

-

Query-parameters:

Parameter	Type	Description	Required	Since
top	int32	No comments found.	false	-
skip	int32	No comments found.	false	-

Parameter

Type

Description

Required

Since

top

int32

No comments found.

false

-

skip

int32

No comments found.

false

-

Request-example:

curl -X GET -i 'http://127.0.0.1/third-party-app/{appId}/subscription?top=0&skip=0'

Response-fields:

Field	Type	Description	Since
totalPages	int32	No comments found.	-
totalElements	int64	No comments found.	-
pageable	object	No comments found.	-
└─pageSize	int32	No comments found.	-
└─pageNumber	int32	No comments found.	-
└─paged	boolean	No comments found.	-
└─unpaged	boolean	No comments found.	-
└─offset	int64	No comments found.	-
└─sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
numberOfElements	int32	No comments found.	-
first	boolean	No comments found.	-
last	boolean	No comments found.	-
size	int32	No comments found.	-
content	array	No comments found.	-
└─id	string	订阅标识	-
└─appId	string	第三方应用标识	-
└─openapiCode	string	对外接口编码	-
└─status	enum	订阅状态	-
└─openapi	object	对外接口详情	-
└─id	string	对外接口标识	-
└─code	string	接口编码即第三方接口调用的路径	-
└─destination	string	后端地址即该接口应该转发到的后端地址	-
└─httpMethod	enum	请求接口的HTTP方法<br/>(See: 开放平台允许使用的HTTP方法)	-
└─status	enum	接口状态<br/>(See: 接口状态)	-
number	int32	No comments found.	-
sort	object	No comments found.	-
└─empty	boolean	No comments found.	-
└─orders	array	No comments found.	-
empty	boolean	No comments found.	-

Field

Type

Description

Since

totalPages

int32

No comments found.

-

totalElements

int64

No comments found.

-

pageable

object

No comments found.

-

└─pageSize

int32

No comments found.

-

└─pageNumber

int32

No comments found.

-

└─paged

boolean

No comments found.

-

└─unpaged

boolean

No comments found.

-

└─offset

int64

No comments found.

-

└─sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

numberOfElements

int32

No comments found.

-

first

boolean

No comments found.

-

last

boolean

No comments found.

-

size

int32

No comments found.

-

content

array

No comments found.

-

└─id

string

订阅标识

-

└─appId

string

第三方应用标识

-

└─openapiCode

string

对外接口编码

-

└─status

enum

订阅状态

-

└─openapi

object

对外接口详情

-

└─id

string

对外接口标识

-

└─code

string

接口编码
即第三方接口调用的路径

-

└─destination

string

后端地址
即该接口应该转发到的后端地址

-

└─httpMethod

enum

请求接口的HTTP方法<br/>(See: 开放平台允许使用的HTTP方法)

-

└─status

enum

接口状态<br/>(See: 接口状态)

-

number

int32

No comments found.

-

sort

object

No comments found.

-

└─empty

boolean

No comments found.

-

└─orders

array

No comments found.

-

empty

boolean

No comments found.

-

Response-example:

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageSize": 0,
    "pageNumber": 0,
    "paged": true,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "empty": true,
      "orders": [
        {
          "object": "any object"
        }
      ]
    }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "id": "",
      "appId": "",
      "openapiCode": "",
      "status": "NONE",
      "openapi": {
        "id": "",
        "code": "",
        "destination": "",
        "httpMethod": "GET",
        "status": "DRAFT"
      }
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "orders": [
      {
        "object": "any object"
      }
    ]
  },
  "empty": true
}

10.5. 更新第三方应用的密钥

URL: http://127.0.0.1/third-party-app/{appId}/roll

Type: PATCH

Author: xezzon

Content-Type: application/x-www-form-urlencoded

Description: 更新第三方应用的密钥

Path-parameters:

Parameter	Type	Description	Required	Since
appId	string	第三方应用ID	true	-

Parameter

Type

Description

Required

Since

appId

string

第三方应用ID

true

-

Request-example:

curl -X PATCH -i 'http://127.0.0.1/third-party-app/{appId}/roll'

Response-fields:

Field	Type	Description	Since
id	string	第三方应用标识	-
secretKey	string	第三方应用密钥	-

Field

Type

Description

Since

id

string

第三方应用标识

-

secretKey

string

第三方应用密钥

-

Response-example:

{
  "id": "",
  "secretKey": ""
}

io.github.xezzon:zeroweb-service-open

10. 第三方应用管理

10.1. 添加第三方应用

10.2. 获取当前用户的所有第三方应用列表

10.3. 查询所有第三方应用列表

10.4. 查询所有已发布的对外接口以及指定第三方应用的订阅情况

10.5. 更新第三方应用的密钥