그누보드에 대한 RESTFUL API Doc #1

꼭 필요한 것 같은데, 없어서 아쉽네요..

이야기 나온 김에,  시간 나는 대로 조금씩 Documen를 만들어 볼까 합니다. (예전만큼 열정이 안 생기긴 하지만.)

RESTFul API의 Doc은 swagger라는 곳이 있습니다.  프레임워크에 적용하면 자동으로 만들어 주죠.

최근에  OpenAPI 라고 이름이 변경 되었습니다. https://swagger.io/specification/

여기서 지원하는 에디터가 있어서 간단하게 Documentation을 할 수가 있습니다.

https://editor.swagger.io/

https://blog.sonim1.com/217  에 간단하게 설명도 있습니다.

첨부파일을 다우노드해서 import file을 해 보시면 아래와 같이 나옵니다.

아래는 그냥 이렇게 된다는 것을 member쪽만 생각나는데로 만들어 봤습니다.  

관심여부에 따라 조금씩 만들어 볼 예정입니다. 

기본은 그누보드/영카트의 데이타베이스 테이블의 필드 네임과 비슷한 이름으로 유지해 볼까 합니다.

확장 필드도 별도로 규정해서, mb_1을 읽어 올수도 있지만, 별도의 테이블을 만들어도 API는 유지되도록..