shelf_swagger_ui

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

Shelf_Swagger_UI는 Flutter/Dart 패키지로, Swagger UI를 Shelf 웹 서버 프레임워크와 통합하여 개발자들이 깔끔하고 상호작용 가능한 API 문서를 생성하고 제공할 수 있도록 합니다. OpenAPI 준수 API를 전문적이고 사용자 친화적인 인터페이스로 쉽게 표시하는 과정을 간소화합니다. Shelf로 구축된 백엔드 서비스에 이상적이며, 브라우저에서 실시간으로 API 탐색이 가능합니다. OpenAPI 사양에서 동적으로 문서를 렌더링하는 기능을 지원하여 팀 간에 API 계약을 유지하고 공유하기 쉬워집니다.

사용 사례

인터랙티브한 API 문서 제공
문서 선반 기반 REST API
실시간 API 테스트 활성화
백엔드 개발 워크플로우와의 통합
API 설계에서 팀 협업을 지원

주요 기능

Shelf와의 원활한 통합
동적 Swagger UI 렌더링
OpenAPI 사양을 지원합니다
브라우저 기반의 상호작용 문서
최소 구성으로 간편한 설정

적합한 대상

Shelf를 사용하는 백엔드 개발자
API 문서가 필요한 팀
OpenAPI 호환 API를 갖춘 프로젝트
실시간 API 미리보기가 필요한 개발 환경
플러터 기반 백엔드 서비스

고려 사항

Shelf 서버 설정이 필요합니다
프론트엔드 사용을 위한 것이 아님
API가 변경되면 문서를 수동으로 업데이트해야 합니다
Swagger UI 기본값을 초과한 사용자 정의는 제한적입니다
개발 및 스테이징에 가장 적합하지만 보안 조치 없이는 프로덕션 배포에는 적합하지 않음

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

Shelf SwaggerUI

Present, clean and professional documentation with Swagger + shelf;

Example

Get a YAML or JSON schema file. Ex: (specs/swagger.yaml)

openapi: 3.0.0
info:
  description: "API system"
  version: "1.0.10"
  title: "Swagger Test"
servers:
  - url: http://my-service.info
    description: Remote server
tags:
- name: "user"
  description: "Access to User"

Configure the handler with Shelf:

import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_swagger_ui/shelf_swagger_ui.dart';

void main(List<String> args) async {
  final path = 'specs/swagger.yaml';
  final handler = SwaggerUI.fromFile(File(path), title: 'Swagger Test');
  var server = await io.serve(handler, '0.0.0.0', 4001);
  print('Serving at http://${server.address.host}:${server.port}');
}

That`s it!

패키지, 저장소 및 앱 카테고리 검색

패키지 설치