2017-05-15 17 views
1

API 플랫폼 및 Symfony 3.2 (백엔드) 및 Ionic 2 (프런트 엔드)를 사용하여 개발 한 RESTFul API에 대한 UML 클래스 다이어그램과 유스 케이스 다이어그램을 만들어야합니다. 하지만 클래스 다이어그램을 통해 백엔드 API의 구조를 설명하는 방법을 정확히 알지 못합니다.UML/API : RESTful API를 모델링하는 방법

누구나 아이디어가 있거나 도움이 될 수 있다면 정말 고맙겠습니다. 고맙습니다!

+1

귀하의 질문은 기본 (또는 어떻게 보느냐에 따라 너무 광범위)하는 방법입니다. 그런 종류의 질문은 "책을 읽으 라"거나 "학급 방문"을 요구합니다. –

+0

@ThomasKilian 답변 해 주셔서 감사합니다. 내 질문은 클래스 다이어그램 내 API의 구성 요소를 나타내는 방법을 알고 싶습니다. 시퀀스 다이어그램은 API와 시스템 간의 상호 작용을 설명 할 수 있으므로 설계하기가 쉽습니다. 그러나 클래스 다이어그램으로 돌아가는 방법, 내 API의 구조를 나타내는 방법을 모르겠다. 귀하의 도움에 많은 감사드립니다 – user7329992

+0

지금까지 어떤 시도를 했습니까? 클래스 다이어그램을 만드는 것은 SD를 만드는 것보다 훨씬 쉽습니다. –

답변

2

Api 플랫폼은 URL의 http://localhost/docs.json에서 API에 대한 스웨이거 문서를 자동으로 생성합니다.

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ : 그래서 내 문제에 대한 해결책은 다음의 모든 조금했다

당신은 https://github.com/nrekretep/pikturr

+0

답장을 보내 주셔서 감사합니다. @ Kévin Dunglas, 나는 이것을 시도하고 간단하고 효과적으로 보입니다. 생명의 은인! – user7329992

2

같은 도구를 사용하여 자신감 문서에서 UML 다이어그램을 생성 할 수 있습니다 내가이에서 결론 클래스 다이어그램에서 평범한 API를 모달 화하는 것은 어렵지만 (기본적으로 메소드가 많기 때문에) "Ressources"와 같은 클래스를 고려하고 메소드 (기본적으로 HTTP 메소드)와 각 resource의 경로를 추가하십시오.

이 또한 큰 도움이었다

또 다른 (간단) 방법은 UML 다이어그램으로 자신감을 변환 Pikturr 같은 도구를 사용하는 것이 었습니다. REST API를 설계

소프트웨어 :

  • 비주얼 패러다임
  • IBM Rational 소프트웨어 아키텍트

도움이 되었기를 바랍니다.