API 指令规范

import "apihug/protobuf/swagger/annotations.proto";

import "apihug/protobuf/mock/mock.proto";

service PetService {
  option (hope.swagger.svc) = {
    path: "/pet";
    description: "宠物管理服务";
  };
}

rpc ListPets (PetQueryRequest) returns (Pet) {
  option (hope.swagger.operation) = {
    post: "/list";
    description: "分页查询宠物列表";
    tags: "pet";
  };
}

option (hope.swagger.operation) = {
  post: "/pets/search";
  pageable: true;
};

option (hope.swagger.operation) = {
  post: "/pets/batch";
  input_repeated: true;
  output_repeated: true;
};

parameters: {
  parameter: {
    name: "id";
    in: PATH;
    schema: {
      format: LONG;
      minimum: 1;
    };
  };
  parameter: {
    name: "include-deleted";
    in: QUERY;
    schema: {
      format: BOOLEAN;
    };
  };
}

parameter: {
  name: "user-id";
  in: QUERY;
  is_repeated: true;
  schema: {
    format: INTEGER;
  };
}

authorization: {
  rbac: {
    authorities: ["PET_VIEW"];
  };
}

message PlaceOrderRequest {
  option (hope.swagger.schema) = {
    json_schema: {
      title: "PlaceOrderRequest";
      description: "下单请求";
    };
  };
}

uint64 id = 1 [(hope.swagger.field) = {
  description: "请求 ID";
  empty: false;
  minimum: 1;
  maximum: 12345;
  example: "1111";
}];

max_length: 64;
maximum: 12345;
nullable: false;

max_length: {value: 64}
maximum: {value: 12345}
nullable: "false"

string owner_id = 1 [(hope.swagger.field) = {
  field_configuration: {
    path_param_name: "owner-id";
  };
}];

string phone = 1 [(hope.swagger.field) = {
  mock: {
    nature: CN_PHONE;
  };
}];

option (hope.swagger.operation) = {
  post: "/ping";
  mock: {
    nature: GUID;
  };
};