Confluence 에 심각한 보안 취약점이 발견되었으니 사용자분들은 업그레이드 하세요.!
laravel

라라벨로 rest api를 서비스중인데, 문서를 만들어야합니다.

 
1
0
-1

안녕하세요. 이번에 인수인계 업무를 통해서 라라벨로 만든 rest api를 문서화하고 있는데요.


혹시 어떤식으로 정리를 해야하고 어떤 문서 형식으로 해야할까요??

    CommentAdd your comment...

    2 answers

    1.  
      2
      1
      0

      swagger도 확인해보세요. laravel 구현체가 있긴한데 저는 조금 불편해서

      node.js에서 yaml으로 작성된 문서를 swagger ui를 이용해서 노출하고있습니다.

      https://github.com/DarkaOnLine/L5-Swagger

      https://swagger.io/swagger-ui/

      1. withrocket

        감사합니다. (_ _)

      CommentAdd your comment...
    2.  
      2
      1
      0

      https://apiblueprint.org/

      이런 솔루션도 있더군요

      각 API END POINT 마다 스펙 정리해주시면 되지 않을까요?

      1. withrocket

        감사합니다.(_ _)

      CommentAdd your comment...