그누보드에 대한 RESTFUL API Doc #1 > 앱개발

앱개발

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

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

첨부파일

gnuboard.0.1.yaml (5.4K) 40회 다운로드 2020-12-15 12:01:45

본문

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

 

이야기 나온 김에,  시간 나는 대로 조금씩 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는 유지되도록..

 

2038410394_1608001044.7693.png

 

 

공감
2

댓글 11개

저도 restapi 가 필요해서 필요한 만큼만 만들어서 사용중입니다.
(회원가입, 회원 수정, 로그인, 로그아웃)
공개할려면 게시판쪽도 만들어야 해서...(귀찮귀찮)

참고로 swagger editor 는 phpstorm 2020.02 버전 부터 제공합니다. 이걸로 편집하면 편합니다.
게다가 기존 phpstorm의 rest-client 와도 연동 됩니다.

혼자만 쓰는거라서 별도로 문서 작업을 하지 않았는데, 만들어두신 yaml로 테스트 한번 해보았습니다.
최근 다른 웹프레임워크에와 비교했을떼 트렌드랑은 동떨여져있는게 그누보드이긴 한데
중소규모사이트에서 웹호스팅 환경에서 설치하기 좋고 사용하기 빠른게 강점이라고 생각합니다.
그누보드를 사용하는 환경에서는 국내 웹환경에서 PUT, DELETE등은 활용하기 어렵더라구요.
그래서 그누보드에 PWA를 붙일때 PUT, DELETE는 POST로 변경하고 별도의 값을 보내는 식으로 수정했었구요.
그래서 저 같은 경우 그누보드 설치가 가능한 환경에서 추가적인 웹환경이나 모듈이 필요하다면 그누보드를 쓰는 의미가 퇴색된다고 생각해서요
vue로 만들때도 임시로 api는 대충 만들긴 했지만 추후 짬이 나서 시간이 된다면 api쪽의 개발도 저는 get과 post만 활용하는걸로 생각하고 있거든요
마찬가지로 라라벨로 API 환경을 제공하는것도 안된다고 생각하고 코드 이그나이터는 가능은 하지만 설정이 귀찮은 부분이 있어서
간단한 라우터 기능만 제공하며 일반적인 웹호스팅 환경에서도 업로드만으로 사용할 수 있는 것들로 개발하는게 낫다는 생각입니다.
꼭 필요한 것 같지만, 그누보드에 언젠가는 필요할 것 같습니다.  그래서 구현 보다는 먼저 Document를 먼저 해 보는 중입니다.  Doc이 있으면 이것을 기반으로 Mockup데이타를 만들어서 앱을 만드시는 분도 나오면 좋고, vue나 react등을 사용하는 분도 나오면 좋고,
jetbrain 제품은 다 제공됩니다만,, android studio 는 제공 안해줍니다.
(안드로이드 앱에서 대부분 restapi로 통신하게 되는데,,, 유료 플러그인이라도 좋으니 판매했으면 좋겠네요.... 이것때문에 indellij 로 android개발할수도 없고...)
전체 756 |RSS
앱개발 내용 검색

회원로그인

진행중 포인트경매

  1. 참여65 회 시작24.04.19 15:40 종료24.04.26 15:40
(주)에스아이알소프트 / 대표:홍석명 / (06211) 서울특별시 강남구 역삼동 707-34 한신인터밸리24 서관 1404호 / E-Mail: admin@sir.kr
사업자등록번호: 217-81-36347 / 통신판매업신고번호:2014-서울강남-02098호 / 개인정보보호책임자:김민섭(minsup@sir.kr)
© SIRSOFT