개발자
오픈API 테스트베드 작성
안녕하세요 2년자 백앤드개발자입니다. 이번에 회사 개발요구사항으로 테스트베드 작성이 있어서 개발진행해야하는데 기존에 swagger를 활용해서 테스트베드로 활용해왔습니다. 다만 이번에는 그 요구사항이 Swagger의 기능 외적인 부분이 많이 추가된듯하여... 새로구축해야할듯한데.. 일반적으로 테스트베드 작성시 어떤방식을 사용하는지 알고싶습니다. 깡으로 FE만들어서 개발계 대응답을 구현해야할지... 아니면 Swagger와 비슷한 툴이 있는지... 또 요구사항중에 Ftp프로토콜로 구현되어 있는 Api도 포함해야한다 하는데 swagger로 가능할지? 선배님들의 도움을 요청드립니다.
답변 1
제가 다녔던 회사들에선 백엔드 API를 공유할 때 swagger를 쓰기도 했고 postman을 쓰기도 했었습니다. swagger의 구현이 어려울 것 같으면 꼭 그걸 쓰지 않는 것도 방법입니다. postman의 사용법도 한번 찾아보시면 좋겠습니다. 또한 둘다로도 구현이 어려울 것 같다면 노가다지만 API 문서를 쓰는겁니다. 엑셀이든, doc이든 해서 API의 명세와 Request, Response정의하시고 목록화해서 공유를 주는것도 일단 주어진 시간 내에 일을 해야 하면 그렇게 하는 겁니다. 이밖에 방법은 스프링이면 Rest Docs인가 그것도 있고 도구는 찾아보면 많이 있을 겁니다. 그럼 적절한 방법 잘 찾아서 해결하시기 바라겠습니다.
익명
작성자
2024년 05월 24일
지금까지 제가 swagger로 민들었던 내부적으로 활용할 api 테스트 문서가 아닌 외부에 보여질 api문서라 더 고심하게됩니다. 역시 가장 깔끔한건 직접 테스트베드 만드는거고 가장 편한건 swagger활용하는거 같네요 답변 감사드립니다.
박정환
HecatonAI Lab Leader • 2024년 05월 24일
내부가 아니라 외부용이라면.. 저같은 경우는 엑셀과 doc, ppt 등으로 노가다 작업 했었습니다. ㅜ swagger조차도 별로라고 안보시는 분들 많더라구요. (일일히 클릭도 뭔가 해봐야 되고..) 안타깝지만 단순한 방법으로 가셔야 할 것 같습니다. 화이팅하시기 바랍니다.
지금 가입하면 모든 질문의 답변을 볼 수 있어요!
현직자들의 명쾌한 답변을 얻을 수 있어요.
이미 회원이신가요?
커리어리 AI 봇
GPT가 달아주는 답변입니다.
2024년 05월 24일
테스트베드를 작성하는 방식은 프로젝트의 요구사항에 따라 다르겠지만, 일반적으로 사용되는 방식 중 몇 가지를 소개하면 아래와 같습니다. 1. Swagger나 Postman과 같은 API 문서화 도구를 활용: 이러한 도구들이 제공하는 모의 서버 기능을 활용하면 API 응답을 빠르게 테스트할 수 있습니다. 또한, 이러한 도구들은 API 문서를 자동으로 생성해주므로 개발자간의 커뮤니케이션 비용을 줄일 수 있습니다. 2. 직접 간단한 클라이언트 애플리케이션을 만듦: 이 방법은 복잡한 로직이나 UI가 필요하지 않은 경우에 적합합니다. 3. Jest 또는 Mocha와 같은 Javascript 테스팅 프레임워크를 사용: 이들 프레임워크는 단위 테스트나 통합 테스트를 쉽게 작성할 수 있도록 돕습니다. 4. WireMock나 Nock 등의 HTTP mocking 라이브러리를 사용: 이는 외부 서버에 의존하지 않고 HTTP 요청과 응답을 시뮬레이션하는데 유용합니다. FTP 프로토콜을 지원하는 API의 경우, Swagger나 Postman 같은 도구로는 테스트가 어려울 수 있습니다. 이 경우, FTP 클라이언트 라이브러리를 사용하여 간단한 테스트 클라이언트를 작성하거나, Python의 ftplib과 같은 라이브러리를 활용하여 스크립트를 작성하는 방법을 고려해볼 수 있습니다.
지금 가입하면 모든 질문의 답변을 볼 수 있어요!