본문 바로가기

Tools/Stoplight

Stoplight Using References

동료 백엔드 개발자가 추천해준 기능

OpenAPI 기능이긴 하지만 UI로 쉽게 가능하게 해준다.

Splitting your API descriptions across multiple files using $ref (references) allows for cleaner and more organized code.

 

Some common use cases are as follows:

  • De-duplicate common structures like models, reducing repetition and allowing them to be used for other purposes like contract testing.
  • Similar parameters or headers can be shared across multiple endpoints.
  • Examples for request or response bodies can be reused.
 

Use References | Platform

Splitting your API descriptions across multiple files using $ref (references) allows for cleaner and more organized code. Powered by Stoplight.

meta.stoplight.io

 

모델 만들어주고 ref로 해당 모델 지정해주면 클릭하면 모델로 이동함

ref 기능이 없으면 매번 모델을 새로 만들어줘야 하는 듯

그래서 duplicate를 제거해준다고 이해함

 

'Tools > Stoplight' 카테고리의 다른 글

Stoplight 사용 후기  (0) 2022.07.10
Stoplight Migrating from Postman  (0) 2022.07.09
Stoplight Starter 유료 기능  (0) 2022.07.09
Stoplight Getting started tutorial 실습 후기  (0) 2022.07.08
Stoplight Set Article Visibility  (0) 2022.06.14