인스턴스의 모든 API 엔드포인트를 프로그래밍 방식으로 가져오는 방법?

[RGJ (Richard - Communiteq)]

@mcwumbly

그렇다면 백엔드 API에 대해 어떤 안정성 보장을 할 수 있을까요?

API 문서가 처리해야 할 책임이라고 생각합니다.

안정성 보장은 직관적인 API 버전 관리로 해결해야 합니다.

@mcwumbly

먼저, 일종의 상위 개념적 모델로 설명하자면 다음과 같습니다:

• 문서를 위한 주요 진입점은 여러분이 지적했듯이 여기입니다: Documentation - Discourse Meta
  • 개발자 문서는 여기에 있으며, 아마도 여기가 더 나을 것입니다: Introduction to Discourse Development
    • API 문서는 개발자 문서의 부분 집합이며, 여기에서 찾을 수 있습니다: https://docs.discourse.org/

API 문서를 *스펙(specs)*이라기보다 *문서(docs)*라고 부르고 싶습니다만, 여전히 개발자 문서의 부분 집합이라는 점에는 동의합니다. 해당 문서의 URL은 다소 이상합니다… 전체 문서가 그곳에 있거나, https://meta.discourse.org/c/documentation/10으로 리다이렉트되고, Introduction to Discourse Development에서 API 문서로 명확한 안내가 이루어지는 것이 더 합리적일 것입니다.

이 주제는 문서가 어디에 있는지, 즉 위치에 관한 것이 아니라 API가 어떻게 문서화되는지에 관한 것입니다. 부족한 것은 OpenAPI와 같은 표준화된 기계 가독 형식입니다.

이러한 부재와 버전 관리의 부재는 통합 작업을 마땅히 그래야 할 것보다 더 어렵고 취약하게 만듭니다. 문서화된 엔드포인트에 대한 기본적인 OpenAPI 스키마만 있어도 정말 도움이 될 것입니다.