🌟 한글명언 OPEN API 기술설명서본 문서는 한글명언 OPEN API 프로젝트의 전반적인 시스템 구성, 사용 기술(버전 포함), 모듈별 역할, 실행 방법, 배포 환경, 관련 링크 정보 및 CI/CD 파이프라인 설정에 관한 설명서입니다.1. 개요api key나 복잡한 인증 필요없이 한글로 번역한 명언을 받아볼 수 있는 OPEN API 서비스 구현2. 관련 링크 📑아래는 프로젝트와 관련된 다양한 링크 정보입니다.API 문서: https://quote.aleph.kr/api-docs/(API 문서 페이지)관리자 페이지: https://quote.aleph.kr/admin(관리자 전용 명언 관리 페이지)깃허브: https://github.com/Aleph-Kim/korean-quote(프로젝트 소스 코드..

개요open api 프로젝트를 진행하던 중 api 문서를 만들 차례가 다가왔고, swagger의 끔찍한 ui를 피하기 위해 어떤 라이브러리를 사용할까 고민하다 apiDoc이라는 간단한 api 문서 생성 라이브러리를 찾아 사용하게 되었다.apiDoc 공식 Live Demo프로젝트 구조project/├── doc/│ ├── assets/│ └── index.html├── src/│ ├── controllers/│ │ └── userController.js│ └── routes/│ └── userRoutes.js├── app.js├── .gitignore├── apidoc.json└── package.jsonapiDoc 사용법1. 라이브러리 설치npm install --save..

개요js fetch api를 사용해 open api에서 정보를 가져오려고 할때 에러가 발생했다.해결방법# 전let res = fetch("https://example.com").json();# 후let res = fetch("https://example.com").then(response => response.json());

REST APIREST 위키피디아정의HTTP URI 를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE) 를 통해 해당 자원에 대한 CRUD Operation(Create, Read, Update, Delete)을 적용하는 것GET - Read : 데이터 요청POST - Create : 데이터 생성PUT - Update : 데이터 전체 업데이트PATCH - Update : 데이터 일부 업데이트DELETE - Delete : 데이터 삭제장점널리 사용되고 있기에 익숙하다.REST API의 메시지를 읽는 것 만으로 요청의 의도를 파악할 수 있다.서버와 클라이언트가 분리되어있어 시스템 확장이 편하다.단점공식적인 표준이 존재하지 않다.엄격한 표준이..

REST API 정의 - REST API는 REST 아키텍처 스타일의 디자인 원칙을 준수하는 API이다. - RESTful API라고도 한다. API(Application Programing Interface)란 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것 REST(Respresentational State Transfer)란 - www와 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어의 한 형식 - 웹에 존재하는 모든 자원에 고유한 uri를 부여해 활용 하는 것 - 자원을 정의하고 자원에 대한 주소를 지정하는 방법론 특징 - 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다..