You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,12 @@
1
1
# OpenAPI Integration with DocC
2
2
3
-
This project provides tools and examples for integrating OpenAPI specifications with Apple's DocC documentation system. It allows developers to create beautiful, interactive documentation for REST APIs that matches the style and quality of Swift API documentation.
3
+
The project aims to bridge the gap between OpenAPI specifications and Swift's DocC documentation framework by developing a tool that automates the generation of DocC documentation from OpenAPI files.
4
4
5
5
## Overview
6
6
7
7
OpenAPI is the industry standard for documenting HTTP services, but Swift developers are already familiar with DocC for their Swift and Objective-C API documentation. This project bridges that gap by converting OpenAPI specifications into a format that DocC can understand and render.
8
8
9
-
## Key Features
10
-
11
-
- Convert OpenAPI 3.1.0 specifications to DocC-compatible format
12
-
- Generate beautiful API documentation
13
-
- Provide a consistent documentation experience for Swift developers
14
-
- Support for documenting endpoints, schemas, parameters, and more
The `docs/` directory in this repository contains the pre-generated DocC documentation website output for the **Swagger Pet Store API**, which was built using the `petstore.symbolgraph.json` generated by this tool and the `API.docc` catalog.
74
76
75
-
### Online Documentation
77
+
### Documentation
76
78
77
79
The latest documentation is automatically deployed to GitHub Pages and can be viewed at:
0 commit comments