0
인가가 할 수있는 간단한 루비 보석 :간단한 API 문서를 생성하는 루비 보석이란 무엇입니까?
동적 경로와 API 컨트롤러 액션 위의 의견에 따라 API 문서를 생성합니다. 새로운 개발자를 위해 코드의 설명서를 원합니다. API 문서 만 별도로 유지 관리하고 싶지 않습니다.
API 문서 웹 사이트를 앱의 별도 경로 아래에 표시하십시오. 필자는 API 문서를 공개하기 위해 별도의 API 문서 서버를 실행하지 않아도됩니다.
사용자 정의 의견 표시. API 끝점에 대한 자세한 설명을 작성하려고합니다. 따라서 API 끝점과 요청/응답 만 보여주는 설명서는 필요 없습니다.
JSON에서 요청 및 응답 예제를 지정하십시오. 다양한 실패 조건에 대한 다중 응답 예제 지정 포함.
(보너스) 설명서 주석에서 Markdown을 해석하십시오.
(보너스) Ruby, Swift와 같은 다양한 언어로 각 API 엔드 포인트를 요청하기위한 코드를 생성하고 보여줍니다.
(보너스) API docs 웹 사이트를 통해 API에 대한 실제 요청을 실행하십시오.
추신 : 이것은 REST API를위한 것이지만 일부 맞춤 경로가있는 경우 실제로 적용되는 경우 변경해야합니다. 레일즈를 사용하고 있습니다.
는 자신감이 반드시 별도의 API 문서 서버의 사용을 필요합니까 사용의 팬? – Magne
그렇지 않습니다. 나는 C# 프로젝트에 대해서만 실제로 사용해 왔지만 보석을 추가하고 설치 생성기를 실행하는 비교적 간단한 설정이라고 생각합니다. 그럼 당신이 할 일은'localhost : 3000/swagger'입니다. 자세한 내용은 [this] (https://github.com/domaindrivendev/rswag)를 확인하십시오. – Rapid99
감사합니다. 나는 레일에서도 그렇게 할 수 있다는 것을 알았다. https://github.com/adrian-gomez/swaggard 사용 – Magne