https://github.com/mattt/swift-package-registry-oas
OpenAPI Specification for proposed Swift Package Registry web service
https://github.com/mattt/swift-package-registry-oas
Last synced: 9 months ago
JSON representation
OpenAPI Specification for proposed Swift Package Registry web service
- Host: GitHub
- URL: https://github.com/mattt/swift-package-registry-oas
- Owner: mattt
- Created: 2020-08-20T13:06:00.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-08-17T10:14:19.000Z (almost 5 years ago)
- Last Synced: 2025-03-30T17:11:08.606Z (over 1 year ago)
- Language: Swift
- Homepage: https://mattt.github.io/swift-package-registry-oas/
- Size: 836 KB
- Stars: 41
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Swift Package Registry - OpenAPI Specification
This project generates an [OpenAPI (v3) Specification](https://swagger.io/specification/)
describing the endpoints of the proposed
[Swift package registry interface](https://github.com/apple/swift-evolution/blob/main/proposals/0292-package-registry-service.md)
It uses [OpenAPIKit](https://github.com/mattpolzin/OpenAPIKit)
to construct and verify the specification in Swift.
Rendered documentation from the latest build of the specification
can be found [here](https://mattt.github.io/swift-package-registry-oas/).
## Requirements
- Swift 5.3+
- Node v14+
- npm
## Usage
Build and run the `generate` executable to print the specification to `stdout`.
```console
$ swift run generate
```
Run the following command to generate a static HTML reference
in the `dist` directory:
```console
$ make
```