REST API 정의 파일 작성

마법사에서 템플리트 swagger.json 파일을 생성하여 REST(Representational State Transfer) API(Application Programming Interface)를 지정할 수 있습니다. 이 마법사는 Liberty 서버를 대상으로 하고 Web 2.5 이상을 사용하는 프로젝트에서 사용할 수 있습니다.

이 태스크 정보

중요사항: Liberty, Liberty Core에 적용 가능

프로시저

  1. Liberty 서버를 대상으로 하는 웹 프로젝트를 작성하십시오.

    웹 프로젝트 작성에 대한 자세한 정보는 웹 프로젝트 작성의 내용을 참조하십시오.

  2. 다음 옵션 중 하나를 완료하여 Swagger REST API 정의 파일을 작성하십시오.
    • 파일 > 새로 작성 > 기타를 선택한 후 REST API 정의 섹션에서 Swagger REST API 정의 파일을 선택하십시오.
    • 프로젝트를 마우스 오른쪽 단추로 클릭하고 새로 작성 > Swagger REST API 정의 파일을 선택하십시오.
  3. 작성할 JSON(JavaScript Object Notation) 파일의 유형을 선택하십시오.
    • 필요한 모든 최상위 Swagger 요소가 있는 파일을 작성하려면 swagger.json 템플리트 파일 작성을 선택하십시오.
    • GET, PUT 및 POST와 같은 공통 정의에 대한 샘플 컨텐츠를 사용하여 파일을 작성하려면 swagger.json 샘플 파일 작성을 선택하십시오.
  4. 작성 중인 파일의 위치를 선택하십시오.
    • Swagger 어노테이션에 대해 작업하려면 스텁 문서로 생성(META-INF/스텁 디렉토리)을 선택하십시오.
    • Swagger 어노테이션에 대해 작업 중이지 않은 경우 상위 레벨 문서로 생성(META-INF 디렉토리)을 선택하십시오.
      참고: 이 옵션은 기본적으로 선택되어 있습니다.
  5. 완료를 클릭하십시오.

결과

이 도구는 웹 프로젝트의 WebContent/META-INF 폴더에 swagger.json 파일을 생성합니다. 이 파일은 기본 JSON 편집기에서 열립니다.

Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_restapi_create.html