TIL

[TIL] Swagger

chengzior 2024. 12. 4. 21:14

 

Swagger
백엔드에서 API 문서화 할때 자주 쓰이는 도구.
요청테스트도 가능


사용방법

1.Swagger 문서 확인
API 명세서(Swagger)를 확인하여 요청 URL, HTTP 메서드, 요청/응답 데이터 구조를 파악

2.Dart 코드 생성

3. Dio 패키지 설치

4. 읽기 작업(GET)

// 클라이언트 코드: 서버 API 호출 및 데이터 처리
Future<List<User>> fetchUsers() async {
  final dio = Dio(); // HTTP 클라이언트 생성
  final response = await dio.get(url); // 서버 요청
  return (response.data as List).map((e) => User.fromJson(e)).toList(); // 데이터 변환
}

5.쓰기 작업(POST)

Future<void> createUser(User user) async {
  await dio.post('/users', data: user.toJson());
}