테스트 사이트 - 개발 중인 베타 버전입니다

개발자분께 의견을 듣고 싶습니다.

· 4년 전 · 1950 · 7

요 근래 개발문서 만드는 작업과 개발문서를 보여주기 위한 프로그램을 작성하고 있는데요.

 

문서를 보여주는 툴? 이 개발자분들이 보셨을 때 볼만한지, 아니면 불편한 부분이 있는지, 또는 부족한 내용이 있는지 의견을 듣고 싶습니다.

제가 만든 프로그램에 대한 문서다보니, 저는 100% 다 알고 있는 상태이고, 그에 따라 당연히 이건 알겠지! 라고 놓치는 부분이 있지 않을까 해서요.

 

혹시나, 시간 괜찮으신분들 계시면 조금만 봐주세요. ㅎㅎㅎ

필요하시다면, 사이트 내 포인트를 드려서 직접 테스트 해볼 수 있게도 해드릴 수 있습니다! > _<

 

API 문서 (자바스크립트용)

https://www.minitalk.io/ko/manual/api/7.1.0/023468123d12c767ed76cfe3f4535c57

 

REST API 문서

https://www.minitalk.io/ko/manual/api/7.1.0/7c749e9bb2a68a3a9290694c0f1b6059

댓글 작성

댓글을 작성하시려면 로그인이 필요합니다.

로그인하기

댓글 7개

API 문서 (자바스크립트용) : 제목 > 내용 이거 숨기지 말고 전부 펼쳐 보이는건 어때요?
찾기(ctrl + f) 로 검색이 가끔 필요하더라구요.

아니면 전체 펼침 버튼 이런 것도 괜찮을 듯 생각됩니다.
@뽁스 코드펜을 이용한 예제가 많아서 펼쳐질때 코드펜 내용을 불러오게 해두었는데 다 펼쳐진 상태라면 로딩속도가 떨어질것 같아서 조금 걱정이네요 ㅠ API 이름을 클릭해도 펼쳐지긴 하는데 내용검색을 추가해서 펼쳐지기전 내용에 포함된 키워드라면 해당 키워드를 포함한 녀석은 검색시 자동으로 펼쳐지게 해 봐야겠네요.
의견 감사합니다. ㅎㅎ
개발보다 문서화가 더 오래 걸리고, 더 어렵습니다. REST API는 요즘 OPENAPI(SWAGGER) Doc을 이용해서 만들어 보고 있습니다.

위의 것도 보기 쉽게 잘 되어 있네요
@마젠토 저도 이미 있는 문서화 서비스 툴을 써볼려고 했는데 홈페이지에 딱 맞게 넣기도 애매하고 원하는 기능(로그인시 자신의 정보를 자동으로 채워주는 것 등)이 없어서 결국 만들게 되었네요. ㅠㅠ
@알쯔 능력이 되시니 직접 만드시면 되죠.. 있는 것 가져다 쓰기도 힘드네요
swagger 말씀드리려 했는데
위에 다 언급이 되었었네요~

알쯔님이 오랜만에 글 쓰신 터라
댓글로 흔적 남기고 갑니다
좋은 주말 되셔요
4년 전
이정도면 충분히 개발자가 보고 연동이 가능하지 않을까 하네요

게시글 목록

번호 제목
1717652
1717651
1717650
1717648
1717635
1717629
1717626
1717625
1717621
1717619
1717611
1717610
1717609
1717607
1717601
1717598
1717591
1717590
1717583
1717575
1717572
1717568
1717566
1717549
1717545
1717533
1717512
1717511
1717508
1717495