Spring REST 문서에 "시험 사용해보기"형식 포함하기

Question

Spring REST Docs를 사용하기 시작했으나 멋진 기능을 놓친다 ... "시험해 보라!" API를 테스트하기위한 HTML 양식이 포함 된 버튼. 나는 컬 링크 OK를 얻는다; 그러나 나는 보통 swagger 형태를 사용한다. 스프링 REST 문서에서이 작업을 수행하는 간단한 방법이 있습니까? 감사합니다.

Answer 1

아니요, 가장 가까운 곳은 예제 요청이있는 curl입니다. 한 간단한 오픈 이죠 컬렉션, https://github.com/spring-projects/spring-restdocs/issues/47을 제공하는 향상된 기능, 아무것도하지만이 자신감의 try it out!

또한 약간이 티켓, https://github.com/spring-projects/spring-restdocs/issues/213에서 관련

, 나는 오히려 생성에 대한 지원을 추가하려고에 찢어진거야

Swagger 사양. Swagger를 "API 놀이터 (API Playground)"를 제공하는 것으로 설명하면 많은 사람들이하지 않는 매우 중요한 차이점을 발견하게됩니다. Swagger의 UI는 API 문서의 대체물이 아니므로 서비스 또는 사용자에게 적합하지 않습니다.

나의 두려움은 봄 REST 문서는 자신감 사양을 생산에 대한 지원을 제공하면, 다른 사람들이 후 자신감의 UI를 채우는 해당 규격을 사용하고 자신의 서비스가 문서화되어야 간주하는 것입니다. 옳은 일을하는 사람들을 신뢰하는 것에 무게를 두는 문제입니다. 대 사람들이 발에서 자신을 쏘라고 격려하는 것과는 대조적입니다.

Answer 2

나는 Spring REST Docs cURL 발췌 문장을 Postman 컬렉션으로 변환하는 도구를 만들어서 직접 풀었다. 명령 행과 라이브러리로 사용할 수있는 npm 패키지 (https://www.npmjs.com/package/restdocs-to-postman)로 사용할 수 있습니다. 이것은 https://github.com/spring-projects/spring-restdocs/issues/47에 대한 하나의 솔루션입니다. 제 생각에는 우편 배달부와 같은 도구는 API를 사용해 보는 것이 좋습니다.

편집 : 우체부와 불면증에서부터 Swagger 로의 변환기가 있습니다. 따라서 두 번의 전환 (Postman/Insomnia 및 Postman/Insomnia to Swagger에 대한 restdocs)을 사용하면 Swagger 놀이터를 얻을 수 있습니다. 이것은 최적은 아니지만 작동합니다. 컨버터

예 : 자신감에

• 이죠 : https://apimatic.io/
• 불면증 자신감에 (재판와 유료 서비스) : https://github.com/mlabouardy/swaggymnia (MIT 라이센스)

편집 2 : 내가 가진 Spring REST에서 Swagger 놀이터를 만드는 방법에 대한 지시 사항을 만들었습니다. 문서 : https://github.com/fbenz/restdocs-to-swagger Spring REST Docs가 무서울 경우 몇 단계 만 거치면 더 간단합니다. Swagger 파일을 생성하지만 작동하고 자동화 할 수 있습니다.