Api-blueprint: JSON-RPC에 대한 URI 오버로딩 지원

apiary.io로 이동합니다.

@rodriguise 이 문제에 대한 정보는 어디에서 찾을 수 있습니까? 저도 같은 생각입니다. RPC와 같은 API를 지원하면 좋은 기능이 될 것입니다.

@rodriguise 저도 이 기능에 매우 관심이 있습니다. 이 문제에 대해 어디에서 배울 수 있습니까?

@adammbalogh @SvyatoslavVasiliev 사용 사례를 좀 더 자세히 설명해 주시겠습니까?

@pksunkara 확실합니다.
JSON-RPC 2.0 사양 에 따라 설계된 API가 있습니다. 예를 들면 다음과 같습니다.

POST http://somehost.com/rpc_api

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "entity.get",
  "params": {
    "filter": {
      "filters": [
        {
          "field": "name",
          "operator": "eq",
          "value": "Bob"
        },
        {
          "field": "age",
          "operator": "eq",
          "value": 25
        }
      ],
      "condition": "and"
    }
  }
}

이러한 API는 "method" 매개변수의 본문에 메서드 이름이 포함된 메서드 그룹에 대한 URL이 하나만 있습니다.
현재 Blueprint 구현에서는 경로 중심 언어 구조로 인해 이러한 API를 설명할 수 없습니다.

안녕하세요 @pksunkara , 이것에 대한 소식이 있습니까?
양봉장 대신 다른 렌더링 도구(예: aglio)를 사용해 보았고 양봉장과 달리 문서를 올바르게 표시했습니다. 그러나 이러한 도구는 속성과 같은 일부 기능을 별도의 섹션으로 렌더링하는 것을 지원하지 않습니다.
내 문제를 해결하는 데 도움이 된다면 매우 좋을 것입니다.

안녕하세요 @SvyatoslavVasiliev 따라서 이것을 올바르게 읽으면 JSON RPC에 대한 지원이 https://github.com/apiaryio/api-blueprint/issues/289에 속 하지만 기술적으로 프로토콜은 여전히 ​​HTTP입니다.

URI 및 HTTP 메서드에서 리소스 및 작업 정의를 분리하면 이 경우에도 도움이 됩니다.

이게 말이 되나요? 자세한 내용은 #289를 참조하세요.

안녕하세요 @zdne님 ,
#289를 이해하려고 노력했지만 완전히 이해할 수 없습니다.
내 API는 JSON 본문과 함께 HTTP를 전송으로 사용하지만 URL이 하나만 있고 HTTP POST만 사용합니다. "method" 매개변수에 포함된 리소스 및 메서드에 대한 모든 정보를 본문에 포함합니다.
예를 들어 엔터티를 가져옵니다.
{ "jsonrpc": "2.0", "id": 1, "method": "entity.get", "params": { "filter": { "filters": [ { "field": "name", "operator": "eq", "value": "Bob" }, { "field": "age", "operator": "eq", "value": 25 } ], "condition": "and" } } }

엔티티 삭제:
{ "jsonrpc": "2.0", "id": 1, "method": "entity.delete", "params": { "id": "123" } }

HTTP POST http://myservice.com/rpcapi 라고 하는 두 가지 방법

지금까지 JSON-RPC API를 문서화하는 현대적이고 기능적인 방법을 찾지 못했습니다(테스트 생성에도 사용할 수 있음). 제 희망은 API Blueprint였지만 실제로 지원되지 않는 것 같습니다. 이에 대한 API Blueprint의 향후 계획을 알고 있거나 이를 지원하는 다른 구조/도구에 대한 제안이 있습니까?

@Dynom 몇 가지 조언을 드릴 수 있습니다.
API 청사진에 대해 Aglio 렌더링을 시도할 수 있지만 속성 섹션을 렌더링하지 않지만 문서의 구조를 올바르게 표시합니다.
또 다른 도구는 API Doc 입니다. 현재 테스트 중이며 적합한 것 같습니다.

@SvyatoslavVasiliev 감사