PolarisMesh

覆盖创建某个服务契约下的接口列表信息数据

POST

/naming/v1/service/contract/methods

最后修改时间：2024-12-09 02:09:09

责任人：未设置

从 1.18.0 开始可用

如果填写了 id，则不需要填写 type、namespace、service、protocol、version 字段

该接口的执行行为为先清理服务契约下的所有接口信息，然后在添加期望的契约接口列表

请求参数

Header 参数

X-Polaris-Token

string

可选

鉴权凭据，当OpenAPI接口鉴权开启时必须开启

Body 参数application/json

type

string

服务契约类型

必需

namespace

string

命名空间

必需

service

string

服务名

必需

protocol

string

协议

必需

http/dubbo/grpc/thrift

version

string

协议版本

必需

interfaces

array [object {3}]

接口列表

必需

method

string

方法

必需

path

string

路径

必需

content

string

接口内容正文

必需

包含方法入参、出参、header等信息

根据 protocol 保存各自特殊的内容

示例

{
  "namespace": "ns1",
  "service": "TestSyncSvc1",
  "protocol": "http",
  "version": "5.0.0",
  "type": "swagger3.0",
  "interfaces": [
    {
      "method": "GET",
      "path": "/zfoo1",
      "content": "foo1|GET"
    },
    {
      "method": "GET",
      "path": "/zfoo2",
      "content": "foo2|GET"
    },
    {
      "method": "GET",
      "path": "/xfoo3",
      "content": "foo3|GET"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://119.91.66.223:8090/naming/v1/service/contract/methods' \
--header 'X-Polaris-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "namespace": "ns1",
    "service": "TestSyncSvc1",
    "protocol": "http",
    "version": "5.0.0",
    "type": "swagger3.0",
    "interfaces": [
        {
        "method": "GET",
        "path": "/zfoo1",
        "content": "foo1|GET"
        },
        {
        "method": "GET",
        "path": "/zfoo2",
        "content": "foo2|GET"
        },
        {
        "method": "GET",
        "path": "/xfoo3",
        "content": "foo3|GET"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

可选

info

string

提示信息

可选

示例

{
  "code": 200000,
  "info": "execute success",
  "serviceContract": {
    "id": "38b1f75572ff438c3e7dc6fcc200d95ff645380c",
    "interfaces": [
      {
        "id": "944783a7cc114d9719a81e77384b1e6159d641f7"
      },
      {
        "id": "4d737dee3502a8e599d5748ab3976d8891bd5747"
      },
      {
        "id": "bc9049130d298254200cc9b398dcc6979855b18c"
      }
    ]
  }
}

修改于 2024-12-09 02:09:09

批量删除服务契约定义

覆盖追加某个服务契约下的接口列表信息数据