오픈 소스 혼자 짤 수 있을까요?

emptynote의 이미지

제목을 자극적으로 만들었지만

결론 부터 말하자자면 오픈 소스 혼자 짤 수 있습니다.

하지만 요즘 들어 오픈 소스 혼자 짤 규모가 아니다라는 생각이 드네요.

API 문서 제공하고 품질을 중요시 하여 단위 테스트를 하고 있다면

리팩토리할때 마다 API 문서와 단위테스트까정 함께 움직여야 합니다.

이게 쉬운 일이 아니네요.

리팩토리 잦다고 핵심 부분만 단위 테스트를 진행하였고

API 문서에 대해서 준비를 안한 상태에서 팀원 모집할려고 API 문서의 필요성을 느껴서

지금 작성중인데 죽겠네요.

악순환의 고리가 있네요.

단위 테스트를 통해서 이것은 무엇이다 라는것을 충분하게 숙고를 하지 않아 이름이 엉망이네요.

API 문서를 작성하려다 보면 설명을 해야 하고 설명을 하다 보면 잘못된 이름을 발견하게 됩니다.

그때마다 잘못된 이름을 수정하느라고 날밤 세네요.

아무리 생각해도 오픈 소스를 혼자 하면서 문서까정 챙기는 분이 있을까 합니다.

chan77xx의 이미지

문서 자동화 도구를 사용하시는게 시간절약이 많이 되더군요.

emptynote의 이미지


제가 웹 개발자로 시작을 했는데

MVC model 2 인 JDF 를 주로 사용했습니다.

그런데 이게 서블릿 그 자체가 API 인데 이것에 대한 문서는 수작업(?)으로 해야 해서

생략(?) 한채로 지냈습니다.

그런데 최근에 swagger 를 알게되었는데

실시간으로 API 문서 만들면서 호출하여 결과까지 살펴 볼 수 있어 감탄이 절로 나옵니다.

다만 코다를 이렇게 활용하는것이다 라는 샘플이라 API 를 만들기가 거시기 하고

또 제가 만든 사이트가 이게 세션키를 구현하기 위한 암호화 라이브러리를 사용해야 하기때문에

이것을 허용해 줄지 모르겠네요.

=============================================
참고 주소 : https://swagger.io/