Skip to content

Commit 7faca7d

Browse files
Update README.md
Signed-off-by: Ayush Srivastava <ayush.srivastav@icloud.com>
1 parent 098823f commit 7faca7d

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
# OpenAPI Integration with DocC
22

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.
44

55
## Overview
66

77
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.
88

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
9+
![2048](https://github.com/user-attachments/assets/f9a751be-9d2f-43f0-8346-04af7edaea57)
1510

1611
## Project Structure
1712

@@ -23,6 +18,13 @@ The project is organized into several modules:
2318
- `Mapping` - Mappers between OpenAPI and SymbolGraph
2419
- `Utils/DocC` - DocC integration utilities
2520

21+
## Key Features
22+
23+
- Convert OpenAPI 3.1.0 specifications to DocC compatible format
24+
- Generate API documentation
25+
- Provide a consistent documentation experience for Swift developers
26+
- Support for documenting endpoints, schemas, parameters, and more
27+
2628
## Getting Started
2729

2830
### Prerequisites
@@ -44,7 +46,6 @@ swift build
4446
1. Convert your OpenAPI specification to a SymbolGraph:
4547

4648
```bash
47-
# Example using one of the provided files
4849
swift run openapi-to-symbolgraph Examples/api.yaml --output-path api.symbolgraph.json
4950
```
5051

@@ -57,6 +58,7 @@ The tool has also been tested with the standard Swagger Pet Store OpenAPI defini
5758
# curl -o Examples/petstore.yaml https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml
5859

5960
# Convert the Pet Store spec
61+
6062
swift run openapi-to-symbolgraph Examples/petstore.yaml --output-path petstore.symbolgraph.json
6163
```
6264

@@ -72,15 +74,15 @@ xcrun docc convert YourAPI.docc --fallback-display-name YourAPI --fallback-bundl
7274

7375
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.
7476

75-
### Online Documentation
77+
### Documentation
7678

7779
The latest documentation is automatically deployed to GitHub Pages and can be viewed at:
7880

7981
[https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/](https://ayushshrivastv.github.io/OpenAPI-integration-with-DocC/)
8082

8183
### Local Documentation Server
8284

83-
You can serve the included Pet Store documentation locally using one of these methods:
85+
You can serve the documentation locally using one of these methods:
8486

8587
#### Using the helper script:
8688

0 commit comments

Comments
 (0)