학습 목표
이 모듈을 마치면 다음을 수행할 수 있습니다.
- Swagger 페이지가 무엇이고 어디에서 찾을 수 있는지 설명하세요
- 앱의 swagger 페이지에서 사용자를 위한 예를 만듭니다.
- 문서로 API 확장
- 모델을 사용하여 고객 또는 구현 파트너가 API 구조를 이해하도록 돕습니다.
Swagger 페이지
Mendix 애플리케이션을 개발할 때 좋은 사용자 경험을 만드는 데 집중하는 것이 중요합니다. API를 개발할 때도 마찬가지입니다. 하지만 API에는 시각적 사용자 인터페이스가 없습니다. 다행히도 게시된 REST 서비스의 경우 API를 더 쉽게 이해할 수 있는 swagger( OpenAPI ) 페이지가 자동으로 생성됩니다. 이 페이지는 /rest-doc/servicename/에서 찾을 수 있습니다.
예시
서비스에서 Mendix 객체를 사용하는 경우 매핑 문서를 만들어야 합니다. 메시지 정의 또는 JSON 스니펫을 통해 만들 수 있습니다.
앱의 swagger 페이지에서 사용자를 위한 예를 만들려면 메시지 정의를 사용하여 매핑 문서를 만들어야 합니다. 예를 제공하면 사용자가 메시지 구조를 이해하는 데 큰 도움이 됩니다. 기본적으로 Mendix는 "string" 및 0과 같은 값으로 이를 채웁니다. 이것은 좋은 시작이지만 전송되는 메시지를 더 잘 나타내는 값을 사용하는 것이 좋습니다.
메시지 정의에서 예제 값을 변경할 수 있습니다.
모델
모델은 사용자가 API 구조를 이해하는 데 도움이 될 수 있습니다. Swagger 페이지에 표시되는 모델은 서비스에 대해 설정한 가져오기 및 내보내기 정의에 따라 달라집니다.
모델은 가져오기 및 내보내기 매핑을 만들고 메시지 정의를 사용할 때만 표시됩니다. 팁: 메시지 정의에서 직접 매핑을 생성 할 수도 있습니다 .
출처 : https://academy.mendix.com/link/paths/133/Design-and-Publish-a-REST-API
'LowCode (Mendix) Advanced > Design and Publish a REST API' 카테고리의 다른 글
| Security (0) | 2024.10.21 |
|---|---|
| Create Responses & Messages (0) | 2024.10.21 |
| Methods (1) | 2024.10.21 |