2016-01-25 24 views
10

Tôi có một ứng dụng web MVC java khởi động mùa xuân. Tôi đã có thể tích hợp Springfox cho tài liệu API. Tôi có thể nhìn thấy tất cả các API khi máy chủ hoạt động và chạy.Làm cách nào để tạo tài liệu API Swagger ngoại tuyến?

Tôi làm cách nào để tạo tài liệu API bỏ qua OFFLINE? Lưu ý: Tôi không muốn sử dụng tài liệu asciidoc hoặc markdown, nhưng tôi muốn có cùng một giao diện người dùng swagger API trong các tệp html. Tôi muốn để các liên kết có liên quan đến thư mục cục bộ thay vì các liên kết máy chủ lưu trữ cục bộ. Cảm ơn

Trả lời

2

Bạn có thể thử "HTML" hoặc "HTML động" trong trình đơn "Tạo khách hàng" trong https://editor.swagger.io. Đối với bất kỳ vấn đề/phản hồi nào với tài liệu tĩnh, vui lòng báo cáo trong Swagger Codegen repo Github.

editor.swagger.io đòn bẩy https://generator.swagger.io để tạo mã và generator.swagger.io (Trình tạo dao găm) là một phần của dự án Swagger Codegen.

5

Springfox cho phép bạn dễ dàng tạo tài liệu trình kiểm tra Swagger/API dựa trên chú thích Spring của bạn.

Swagger chính nó có một số công cụ cho phép bạn tạo ra ẩn/tài liệu tĩnh:

  • Các Swagger Editor có một số cách để tạo ra tài liệu được liệt kê trong Tạo Khách hàng đơn
  • Module Swagger Codegen cho phép bạn tạo tài liệu HTML tĩnh và động

Cả hai đều yêu cầu tệp YAML hoặc JSON Swagger. Trong trường hợp bạn không có định nghĩa Swagger trong YAML/JSON vì bạn đang sử dụng Springfox, bạn có thể sử dụng tệp được tạo sử dụng cho giao diện người dùng Swagger (/v2/api-docs?group=<group name>).

1

Bạn có thể xem https://www.DynamicApis.com. Bạn có thể tạo một cổng API và tải lên các tài liệu JSON của bạn. Trang web này lấy tài liệu Swagger và tạo ra một giao diện người dùng đẹp hơn cho API của bạn cùng với một số công cụ khá thú vị.

Here là ví dụ về API cổng thông tin có tài liệu về một trong các API của họ.

4

Swagger có công cụ để tạo tài liệu ngoại tuyến.

Công cụ này là "Swagger2Markup" nằm ở @ Github.

Đầu ra của "Swagger2Markup" có thể được sử dụng làm phương án thay thế cho dao găm-ui và có thể được sử dụng làm nội dung tĩnh.

Here is an Example

Chúc may mắn! :)

0

Khá swag là giao diện người dùng cho Đặc điểm Swagger V2 có khả năng tạo HTML tĩnh một định dạng khác. Nó được lấy cảm hứng từ Swagger Editor.

checkout https://github.com/twskj/pretty-swag

Các vấn đề liên quan