Lattice.Hub
GitHub

Lattice Hub Docs
HTTP OpenAPIServices

Contracts

Query service contracts and client reporting.

Query service contracts and client reporting.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Service contracts

Contract query/management; client report uses /v1/ReportServiceContract.

GET/naming/v1/service/contractsAuth required

List service contracts

List contracts for a service (query via ParseQueryParams).

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    Namespace.

  • servicequery · stringoptional

    Service name.

  • namequery · stringoptional

    Contract name.

  • protocolquery · stringoptional

    Protocol.

  • versionquery · stringoptional

    Version.

  • limitquery · integeroptional

    Page size.

Request
curl -sS 'http://127.0.0.1:8090/naming/v1/service/contracts?namespace=default&service=payment' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "data": [{ "name": "payment", "protocol": "http" }]
}
POST/naming/v1/service/contractsAuth required

Create service contracts

Create contracts from management surface; body is ServiceContract[].

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namebody · stringrequired

    Contract / service-related name.

  • namespacebody · stringrequired

    Namespace.

  • servicebody · stringrequired

    Service name.

  • protocolbody · stringoptional

    Protocol such as http / grpc.

  • versionbody · stringoptional

    Contract version.

  • contentbody · stringoptional

    Contract text (OpenAPI / proto).

  • typebody · stringoptional

    Contract type.

  • interfacesbody · Interface[]optional

    Interfaces.

  • metadatabody · map<string,string>optional

    Metadata.

  • idbody · stringoptional

    Contract ID (delete, etc.).

Request
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/contracts' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"payment","namespace":"default","service":"payment","protocol":"http","content":"openapi: 3.0.3"}]'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
GET/naming/v1/service/contract/versionsAuth required

List contract versions

List contract versions.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • namespacequery · stringoptional

    Namespace.

  • servicequery · stringoptional

    Service name.

Request
curl -sS 'http://127.0.0.1:8090/naming/v1/service/contract/versions?namespace=default&service=payment' \
  -H "Authorization: $TOKEN"
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/v1/ReportServiceContract

Report service contract

Clients report contracts (may include OpenAPI text). Not the control-plane OpenAPI itself.

Parameters

  • (body)body · ServiceContract[]required

    Request body is a JSON array of ServiceContract: [{...}, ...]. Fields below are the full per-item schema (including nested).

  • idbody · stringoptional

    契约ID

  • namebody · stringoptional

    契约名称 deprecated, use type field

  • namespacebody · stringoptional

    所属命名空间

  • servicebody · stringoptional

    所属服务名称

  • protocolbody · stringoptional

    协议，http/grpc/dubbo/thrift

  • versionbody · stringoptional

    契约版本

  • contentbody · stringoptional

    额外描述

  • interfacesbody · InterfaceDescriptor[]optional

    interfaces

    • idbody · stringoptional

      接口ID

    • methodbody · stringoptional

      方法名称，对应 http method/ dubbo interface func/grpc service func

    • pathbody · stringoptional

      接口名称，http path/dubbo interface/grpc service

    • contentbody · stringoptional

      接口描述信息

    • sourcebody · enum(Source)optional

      创建来源 enum: UNKNOWN

    • namebody · stringoptional

      接口名称描述信息 deprecated, use type field

    • namespacebody · stringoptional

      所属命名空间

    • servicebody · stringoptional

      所属服务名称

    • protocolbody · stringoptional

      协议，http/grpc/dubbo/thrift

    • versionbody · stringoptional

      契约版本

    • typebody · stringoptional

      类型

    • content_digestbody · stringoptional

      内容摘要

  • typebody · stringoptional

    类型

  • metadatabody · map<string,string>optional

    metadata

  • content_digestbody · stringoptional

    内容摘要

Response fields

  • codebody · uint32required

    Business code; success is usually 200000.

  • infobody · stringoptional

    Info message.

  • serviceContractbody · ServiceContractoptional

    ServiceContract entity fields (batch APIs nest under responses[]).

    • idbody · stringoptional

      契约ID

    • namebody · stringoptional

      契约名称 deprecated, use type field

    • namespacebody · stringoptional

      所属命名空间

    • servicebody · stringoptional

      所属服务名称

    • protocolbody · stringoptional

      协议，http/grpc/dubbo/thrift

    • versionbody · stringoptional

      契约版本

    • revisionbody · stringoptional

      信息摘要

    • contentbody · stringoptional

      额外描述

    • interfacesbody · InterfaceDescriptor[]optional

      interfaces

      • idbody · stringoptional

        接口ID

      • methodbody · stringoptional

        方法名称，对应 http method/ dubbo interface func/grpc service func

      • pathbody · stringoptional

        接口名称，http path/dubbo interface/grpc service

      • contentbody · stringoptional

        接口描述信息

      • sourcebody · enum(Source)optional

        创建来源 enum: UNKNOWN

      • revisionbody · stringoptional

        接口信息摘要

      • ctimebody · stringoptional

        创建时间

      • mtimebody · stringoptional

        更新时间

      • namebody · stringoptional

        接口名称描述信息 deprecated, use type field

      • namespacebody · stringoptional

        所属命名空间

      • servicebody · stringoptional

        所属服务名称

      • protocolbody · stringoptional

        协议，http/grpc/dubbo/thrift

      • versionbody · stringoptional

        契约版本

      • typebody · stringoptional

        类型

      • content_digestbody · stringoptional

        内容摘要

    • ctimebody · stringoptional

      创建时间

    • mtimebody · stringoptional

      更新时间

    • statusbody · stringoptional

      接口状态，Offline/Online

    • typebody · stringoptional

      类型

    • metadatabody · map<string,string>optional

      metadata

    • content_digestbody · stringoptional

      内容摘要

Request
curl -sS -X POST 'http://127.0.0.1:8090/v1/ReportServiceContract' \
  -H 'Content-Type: application/json' \
  -d '{"name":"payment","namespace":"default","service":"payment","protocol":"http","content":"openapi: 3.0.3"}'
Response example
{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}
POST/naming/v1/service/contracts/deleteAuth required

Delete service contracts

Delete service contracts.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • (body)body · ServiceContract[]required

    JSON array of ServiceContract; fields below are per-item.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • servicebody · stringoptional

    service

  • protocolbody · stringoptional

    protocol

  • versionbody · stringoptional

    version

  • contentbody · stringoptional

    content

  • interfacesbody · InterfaceDescriptor[]optional

    interfaces

    • idbody · stringoptional

      id

    • methodbody · stringoptional

      method

    • pathbody · stringoptional

      path

    • contentbody · stringoptional

      content

    • sourcebody · enum(Source)optional

      source enum: UNKNOWN

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • typebody · stringoptional

      type

    • content_digestbody · stringoptional

      content_digest

  • typebody · stringoptional

    type

  • metadatabody · map<string,string>optional

    metadata

  • content_digestbody · stringoptional

    content_digest

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ServiceContractbody · ServiceContractoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • revisionbody · stringoptional

      revision

    • contentbody · stringoptional

      content

    • interfacesbody · InterfaceDescriptor[]optional

      interfaces

      • idbody · stringoptional

        id

      • methodbody · stringoptional

        method

      • pathbody · stringoptional

        path

      • contentbody · stringoptional

        content

      • sourcebody · enum(Source)optional

        source enum: UNKNOWN

      • revisionbody · stringoptional

        revision

      • ctimebody · stringoptional

        ctime

      • mtimebody · stringoptional

        mtime

      • namebody · stringoptional

        name

      • namespacebody · stringoptional

        namespace

      • servicebody · stringoptional

        service

      • protocolbody · stringoptional

        protocol

      • versionbody · stringoptional

        version

      • typebody · stringoptional

        type

      • content_digestbody · stringoptional

        content_digest

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • statusbody · stringoptional

      status

    • typebody · stringoptional

      type

    • metadatabody · map<string,string>optional

      metadata

    • content_digestbody · stringoptional

      content_digest

Request
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/contracts/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/naming/v1/service/contract/methodsAuth required

Create contract methods

Create contract methods.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • servicebody · stringoptional

    service

  • protocolbody · stringoptional

    protocol

  • versionbody · stringoptional

    version

  • contentbody · stringoptional

    content

  • interfacesbody · InterfaceDescriptor[]optional

    interfaces

    • idbody · stringoptional

      id

    • methodbody · stringoptional

      method

    • pathbody · stringoptional

      path

    • contentbody · stringoptional

      content

    • sourcebody · enum(Source)optional

      source enum: UNKNOWN

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • typebody · stringoptional

      type

    • content_digestbody · stringoptional

      content_digest

  • typebody · stringoptional

    type

  • metadatabody · map<string,string>optional

    metadata

  • content_digestbody · stringoptional

    content_digest

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ServiceContractbody · ServiceContractoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • revisionbody · stringoptional

      revision

    • contentbody · stringoptional

      content

    • interfacesbody · InterfaceDescriptor[]optional

      interfaces

      • idbody · stringoptional

        id

      • methodbody · stringoptional

        method

      • pathbody · stringoptional

        path

      • contentbody · stringoptional

        content

      • sourcebody · enum(Source)optional

        source enum: UNKNOWN

      • revisionbody · stringoptional

        revision

      • ctimebody · stringoptional

        ctime

      • mtimebody · stringoptional

        mtime

      • namebody · stringoptional

        name

      • namespacebody · stringoptional

        namespace

      • servicebody · stringoptional

        service

      • protocolbody · stringoptional

        protocol

      • versionbody · stringoptional

        version

      • typebody · stringoptional

        type

      • content_digestbody · stringoptional

        content_digest

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • statusbody · stringoptional

      status

    • typebody · stringoptional

      type

    • metadatabody · map<string,string>optional

      metadata

    • content_digestbody · stringoptional

      content_digest

Request
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/contract/methods' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
PUT/naming/v1/service/contract/methods/appendAuth required

Append contract methods

Append contract methods.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • servicebody · stringoptional

    service

  • protocolbody · stringoptional

    protocol

  • versionbody · stringoptional

    version

  • contentbody · stringoptional

    content

  • interfacesbody · InterfaceDescriptor[]optional

    interfaces

    • idbody · stringoptional

      id

    • methodbody · stringoptional

      method

    • pathbody · stringoptional

      path

    • contentbody · stringoptional

      content

    • sourcebody · enum(Source)optional

      source enum: UNKNOWN

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • typebody · stringoptional

      type

    • content_digestbody · stringoptional

      content_digest

  • typebody · stringoptional

    type

  • metadatabody · map<string,string>optional

    metadata

  • content_digestbody · stringoptional

    content_digest

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ServiceContractbody · ServiceContractoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • revisionbody · stringoptional

      revision

    • contentbody · stringoptional

      content

    • interfacesbody · InterfaceDescriptor[]optional

      interfaces

      • idbody · stringoptional

        id

      • methodbody · stringoptional

        method

      • pathbody · stringoptional

        path

      • contentbody · stringoptional

        content

      • sourcebody · enum(Source)optional

        source enum: UNKNOWN

      • revisionbody · stringoptional

        revision

      • ctimebody · stringoptional

        ctime

      • mtimebody · stringoptional

        mtime

      • namebody · stringoptional

        name

      • namespacebody · stringoptional

        namespace

      • servicebody · stringoptional

        service

      • protocolbody · stringoptional

        protocol

      • versionbody · stringoptional

        version

      • typebody · stringoptional

        type

      • content_digestbody · stringoptional

        content_digest

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • statusbody · stringoptional

      status

    • typebody · stringoptional

      type

    • metadatabody · map<string,string>optional

      metadata

    • content_digestbody · stringoptional

      content_digest

Request
curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/service/contract/methods/append' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}
POST/naming/v1/service/contract/methods/deleteAuth required

Delete contract methods

Delete contract methods.

Parameters

  • Authorizationheader · stringrequired

    Token from login.

  • idbody · stringoptional

    id

  • namebody · stringoptional

    name

  • namespacebody · stringoptional

    namespace

  • servicebody · stringoptional

    service

  • protocolbody · stringoptional

    protocol

  • versionbody · stringoptional

    version

  • contentbody · stringoptional

    content

  • interfacesbody · InterfaceDescriptor[]optional

    interfaces

    • idbody · stringoptional

      id

    • methodbody · stringoptional

      method

    • pathbody · stringoptional

      path

    • contentbody · stringoptional

      content

    • sourcebody · enum(Source)optional

      source enum: UNKNOWN

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • typebody · stringoptional

      type

    • content_digestbody · stringoptional

      content_digest

  • typebody · stringoptional

    type

  • metadatabody · map<string,string>optional

    metadata

  • content_digestbody · stringoptional

    content_digest

Response fields

  • codebody · uint32required

    Business code.

  • infobody · stringoptional

    Info.

  • ServiceContractbody · ServiceContractoptional

    Entity fields.

    • idbody · stringoptional

      id

    • namebody · stringoptional

      name

    • namespacebody · stringoptional

      namespace

    • servicebody · stringoptional

      service

    • protocolbody · stringoptional

      protocol

    • versionbody · stringoptional

      version

    • revisionbody · stringoptional

      revision

    • contentbody · stringoptional

      content

    • interfacesbody · InterfaceDescriptor[]optional

      interfaces

      • idbody · stringoptional

        id

      • methodbody · stringoptional

        method

      • pathbody · stringoptional

        path

      • contentbody · stringoptional

        content

      • sourcebody · enum(Source)optional

        source enum: UNKNOWN

      • revisionbody · stringoptional

        revision

      • ctimebody · stringoptional

        ctime

      • mtimebody · stringoptional

        mtime

      • namebody · stringoptional

        name

      • namespacebody · stringoptional

        namespace

      • servicebody · stringoptional

        service

      • protocolbody · stringoptional

        protocol

      • versionbody · stringoptional

        version

      • typebody · stringoptional

        type

      • content_digestbody · stringoptional

        content_digest

    • ctimebody · stringoptional

      ctime

    • mtimebody · stringoptional

      mtime

    • statusbody · stringoptional

      status

    • typebody · stringoptional

      type

    • metadatabody · map<string,string>optional

      metadata

    • content_digestbody · stringoptional

      content_digest

Request
curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/service/contract/methods/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'
Response example
{
  "code": 200000,
  "info": "execute success"
}

Service basics

Create, query, and update services.

Call topology

Service subscribers and call relations.

On this page

GET List service contractsPOST Create service contractsGET List contract versionsPOST Report service contractPOST Delete service contractsPOST Create contract methodsPUT Append contract methodsPOST Delete contract methods