꼭 필요한 것 같은데, 없어서 아쉽네요..
이야기 나온 김에, 시간 나는 대로 조금씩 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는 유지되도록..
댓글 11개
저도 restapi 가 필요해서 필요한 만큼만 만들어서 사용중입니다.
(회원가입, 회원 수정, 로그인, 로그아웃)
공개할려면 게시판쪽도 만들어야 해서...(귀찮귀찮)
참고로 swagger editor 는 phpstorm 2020.02 버전 부터 제공합니다. 이걸로 편집하면 편합니다.
게다가 기존 phpstorm의 rest-client 와도 연동 됩니다.
혼자만 쓰는거라서 별도로 문서 작업을 하지 않았는데, 만들어두신 yaml로 테스트 한번 해보았습니다.
[http://sir.kr/data/editor/2012/ac468022a282684d4d1785177570dde2_1608017464_2555.png]
(회원가입, 회원 수정, 로그인, 로그아웃)
공개할려면 게시판쪽도 만들어야 해서...(귀찮귀찮)
참고로 swagger editor 는 phpstorm 2020.02 버전 부터 제공합니다. 이걸로 편집하면 편합니다.
게다가 기존 phpstorm의 rest-client 와도 연동 됩니다.
혼자만 쓰는거라서 별도로 문서 작업을 하지 않았는데, 만들어두신 yaml로 테스트 한번 해보았습니다.
[http://sir.kr/data/editor/2012/ac468022a282684d4d1785177570dde2_1608017464_2555.png]
최근 다른 웹프레임워크에와 비교했을떼 트렌드랑은 동떨여져있는게 그누보드이긴 한데
중소규모사이트에서 웹호스팅 환경에서 설치하기 좋고 사용하기 빠른게 강점이라고 생각합니다.
그누보드를 사용하는 환경에서는 국내 웹환경에서 PUT, DELETE등은 활용하기 어렵더라구요.
그래서 그누보드에 PWA를 붙일때 PUT, DELETE는 POST로 변경하고 별도의 값을 보내는 식으로 수정했었구요.
그래서 저 같은 경우 그누보드 설치가 가능한 환경에서 추가적인 웹환경이나 모듈이 필요하다면 그누보드를 쓰는 의미가 퇴색된다고 생각해서요
vue로 만들때도 임시로 api는 대충 만들긴 했지만 추후 짬이 나서 시간이 된다면 api쪽의 개발도 저는 get과 post만 활용하는걸로 생각하고 있거든요
마찬가지로 라라벨로 API 환경을 제공하는것도 안된다고 생각하고 코드 이그나이터는 가능은 하지만 설정이 귀찮은 부분이 있어서
간단한 라우터 기능만 제공하며 일반적인 웹호스팅 환경에서도 업로드만으로 사용할 수 있는 것들로 개발하는게 낫다는 생각입니다.
중소규모사이트에서 웹호스팅 환경에서 설치하기 좋고 사용하기 빠른게 강점이라고 생각합니다.
그누보드를 사용하는 환경에서는 국내 웹환경에서 PUT, DELETE등은 활용하기 어렵더라구요.
그래서 그누보드에 PWA를 붙일때 PUT, DELETE는 POST로 변경하고 별도의 값을 보내는 식으로 수정했었구요.
그래서 저 같은 경우 그누보드 설치가 가능한 환경에서 추가적인 웹환경이나 모듈이 필요하다면 그누보드를 쓰는 의미가 퇴색된다고 생각해서요
vue로 만들때도 임시로 api는 대충 만들긴 했지만 추후 짬이 나서 시간이 된다면 api쪽의 개발도 저는 get과 post만 활용하는걸로 생각하고 있거든요
마찬가지로 라라벨로 API 환경을 제공하는것도 안된다고 생각하고 코드 이그나이터는 가능은 하지만 설정이 귀찮은 부분이 있어서
간단한 라우터 기능만 제공하며 일반적인 웹호스팅 환경에서도 업로드만으로 사용할 수 있는 것들로 개발하는게 낫다는 생각입니다.
게시글 목록
| 번호 | 제목 |
|---|---|
| 2024 | |
| 2019 |
Hybrid
Flutter 데모 및 소스코드
4
|
| 2015 |
Hybrid
node참 좋네요.
2
|
| 2011 |
Android
안드로이드 스튜디오 그누보드 DB 연결 로그인
12
|
| 2009 | |
| 2005 | |
| 1992 | |
| 1987 | |
| 1986 | |
| 1984 | |
| 1982 | |
| 1970 | |
| 1967 | |
| 1966 | |
| 1962 | |
| 1948 | |
| 1947 | |
| 1944 | |
| 1942 | |
| 1938 | |
| 1936 | |
| 1932 | |
| 1931 | |
| 1928 | |
| 1926 | |
| 1914 | |
| 1913 | |
| 1901 | |
| 1896 | |
| 1893 |
댓글 작성
댓글을 작성하시려면 로그인이 필요합니다.
로그인하기