Committed the generated OpenAPI sources instead of using the plugin.
This commit is contained in:
1 parent
c984be3263
commit
a303150963
7 files changed
+1012376
-20
No files matched your search
@@ -4,9 +4,7 @@ A Swift client library for the App Store Connect API, generated from the officia
|
||||
|
||||
## Overview
|
||||
|
||||
`ASConnectService` provides a type-safe, Swift-native interface to Apple's App Store Connect API. This package enables developers to programmatically interact with App Store Connect services for managing apps, builds, reviews, sales reports, and more.
|
||||
|
||||
The library is automatically generated from the official App Store Connect API OpenAPI specification using Apple's [swift-openapi-generator](https://github.com/apple/swift-openapi-generator), ensuring complete API coverage and type safety.
|
||||
`ASConnectService` exposes every endpoint of Apple's App Store Connect API as a Swift method with typed requests and responses. It's generated from the official OpenAPI specification with [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -33,13 +31,7 @@ Then add it to your target dependencies:
|
||||
|
||||
### Creating a Client
|
||||
|
||||
Create a `Client` instance by providing a server URL and transport. Use `BearerAuthMiddleware` to authenticate requests with a JSON Web Token (JWT).
|
||||
|
||||
The App Store Connect API requires authentication using API keys. You'll need to:
|
||||
|
||||
1. Create an API key in App Store Connect
|
||||
2. Generate a signed JWT token using your key ID, issuer ID, and private key
|
||||
3. Pass the token to the built-in `BearerAuthMiddleware` when creating the client
|
||||
Create a `Client` with a server URL, a transport, and a `BearerAuthMiddleware` that authenticates each request with a JSON Web Token (JWT). To get a token, create an API key in App Store Connect and sign a JWT with its key ID, issuer ID, and private key:
|
||||
|
||||
```swift
|
||||
import ASConnectService
|
||||
@@ -123,11 +115,26 @@ make doc-generate-github
|
||||
make doc-preview
|
||||
```
|
||||
|
||||
### Updating the API
|
||||
|
||||
The generated code is committed in `Sources/ASConnectService/Sources/Public/Generated`, so consumers don't run the generator.
|
||||
|
||||
```bash
|
||||
# Update to the latest specification
|
||||
make oas-download
|
||||
|
||||
# Regenerate the code only
|
||||
make oas-generate
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [swift-openapi-generator](https://github.com/apple/swift-openapi-generator)
|
||||
- [swift-openapi-runtime](https://github.com/apple/swift-openapi-runtime)
|
||||
- [swift-openapi-urlsession](https://github.com/apple/swift-openapi-urlsession)
|
||||
|
||||
Development only:
|
||||
|
||||
- [swift-openapi-generator](https://github.com/apple/swift-openapi-generator), in `Tools`
|
||||
- [swift-docc-plugin](https://github.com/swiftlang/swift-docc-plugin)
|
||||
|
||||
## License
|
||||
|
||||
Reference in new issue
Block a user