Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mortengregersen/bagbutik
Generated Swift code for the App Store Connect API based on the official OpenAPI spec.
https://github.com/mortengregersen/bagbutik
appstoreconnect appstoreconnectapi openapi openapi-spec swift
Last synced: 3 days ago
JSON representation
Generated Swift code for the App Store Connect API based on the official OpenAPI spec.
- Host: GitHub
- URL: https://github.com/mortengregersen/bagbutik
- Owner: MortenGregersen
- License: mit
- Created: 2021-01-30T20:08:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T23:51:30.000Z (5 months ago)
- Last Synced: 2024-05-01T19:17:14.591Z (5 months ago)
- Topics: appstoreconnect, appstoreconnectapi, openapi, openapi-spec, swift
- Language: Swift
- Homepage:
- Size: 5.44 MB
- Stars: 146
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Generated Swift code for the App Store Connect API based on the official OpenAPI spec.
## What is Bagbutik?
**Bag·bu·tik** (noun) **[/ˈb̥a̝w-ˌb̥u-tiːk/](http://ipa-reader.xyz/?text=ˈb̥a̝w-ˌb̥u-ti%CB%90k&voice=Amy)** - _(Danish) A room behind a store_
Bagbutik is two things, a command line tool for generating Swift code, and a library with the generated code for the App Store Connect API. The command line tool decodes the official [OpenAPI spec](https://en.wikipedia.org/wiki/OpenAPI_Specification) for Apple's [App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi).
While generating the code, the command line tool also downloads the official documentation from [Apple's Documentation site for the App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi) and applies it to the generated code, so you can get documentation right in Xcode.
The command line tool is only needed, when Apple publishes a new version of the spec. A [GitHub Action](https://github.com/MortenGregersen/Bagbutik/actions/workflows/check-for-new-spec.yml) automatically checks for new versions of the spec and creates a pull request with the changes.
## How to use Bagbutik
Bagbutik uses JSON Web Tokens (JWT) for authorization. You obtain the required keys from your organization's App Store Connect account.
> See [Creating API Keys for App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api) for how to create your keys.
Here is a basic example for fetching all bundle IDs for iOS apps including related profiles sorted by seed ID and the bundle ID itself descending.
```swift
import Bagbutik_Core
import Bagbutik_Provisioning
let service = BagbutikService(jwt: try .init(
keyId: "P9M252746H",
issuerId: "82067982-6b3b-4a48-be4f-5b10b373c5f2",
privateKey: """
-----BEGIN PRIVATE KEY-----
MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgevZzL1gdAFr88hb2
OF/2NxApJCzGCEDdfSp6VQO30hyhRANCAAQRWz+jn65BtOMvdyHKcvjBeBSDZH2r
1RTwjmYSi9R/zpBnuQ4EiMnCqfMPWiZqB4QdbAd0E7oH50VpuZ1P087G
-----END PRIVATE KEY-----
"""
))
let response = try await service.request(
.listBundleIdsV1(filters: [.platform([.iOS])],
includes: [.profiles],
sorts: [.seedIdDescending, .idDescending])
)
print(response)
```
## How to get Bagbutik into a project
Bagbutik supports [Swift Package Manager](https://www.swift.org/package-manager) and the internal libraries used to generate the code is also managed by it.
The library of generated code actually consists of multiple libraries, to let the consumer only depend on the endpoints needed.
So to get Bagbutik, you need to decide which functionality you need.
In your `Package.swift` add Bagbutik as a dependency:
```swift
dependencies: [
.package(url: "https://github.com/MortenGregersen/Bagbutik", from: "8.0.0"),
```
Then in `targets` add the libraries needed by your target:
```swift
targets: [
.target(
name: "Awesome",
dependencies: [
.product(name: "Bagbutik-AppStore", package: "Bagbutik"),
.product(name: "Bagbutik-TestFlight", package: "Bagbutik"),
```
If all libraries are needed, the umbrella library `Bagbutik` can be used:
```swift
targets: [
.target(
name: "Awesome",
dependencies: [
.product(name: "Bagbutik", package: "Bagbutik"),
```
> Remember to replace the hyphen with an underscore when importing the libraries.
>
> When importing `Bagbutik-TestFlight` write:
```swift
import Bagbutik_TestFlight
```
### `Bagbutik-Core`
The core library is `Bagbutik-Core` which contains the `BagbutikService`, the `JWT`, protocols and the general generated types like `ErrorResponse` and `PagingInformation`.
All other libraries depend on `Bagbutik-Core`. This is the only library which is documented on [Bagbutik.dev](https://bagbutik.dev), as the other libraries only contain types which are already [documented by Apple](https://developer.apple.com/documentation/appstoreconnectapi).
### `Bagbutik-Models`
Because the models from the API are used from many different endpoints, they are all located in `Bagbutik-Models`. All libraries with endpoints depend on `Bagbutik-Models`.
### `Bagbutik-`
The endpoints of all the areas of the App Store Connect API are located in different libraries with a describing name.
Right now there are 7 libraries with endpoints:
* `Bagbutik-AppStore`: Manage all [aspects of your app, App Clips, in-app purchases, and customer reviews in the App Store](https://developer.apple.com/documentation/appstoreconnectapi/app_store).
* `Bagbutik-GameCenter`: Manage [Game Center data and configurations for your apps](https://developer.apple.com/documentation/appstoreconnectapi/game_center).
* `Bagbutik-Marketplaces`: Manage [keys, packages, and search for the marketplace distribution of your app](https://developer.apple.com/documentation/appstoreconnectapi/game_center).
* `Bagbutik-Provisioning`: Manage the [bundle IDs](https://developer.apple.com/documentation/appstoreconnectapi/bundle_ids), [certificates](https://developer.apple.com/documentation/appstoreconnectapi/certificates), [devices](https://developer.apple.com/documentation/appstoreconnectapi/devices) and [provisioning profiles](https://developer.apple.com/documentation/appstoreconnectapi/profiles) for your app.
* `Bagbutik-Reporting`: Download your [sales and financial reports](https://developer.apple.com/documentation/appstoreconnectapi/sales_and_finance_reports) and [get power and performance metrics, logs, and signatures](https://developer.apple.com/documentation/appstoreconnectapi/power_and_performance_metrics_and_logs).
* `Bagbutik-TestFlight`: Manage your [beta testing program, including beta testers and groups, apps, App Clips, and builds](https://developer.apple.com/documentation/appstoreconnectapi/prerelease_versions_and_beta_testers).
* `Bagbutik-Users`: Manage [users](https://developer.apple.com/documentation/appstoreconnectapi/users) and [email invitations to join](https://developer.apple.com/documentation/appstoreconnectapi/user_invitations) your App Store Connect team.
* `Bagbutik-XcodeCloud`: Automate [reading Xcode Cloud data, managing workflows, and starting builds](https://developer.apple.com/documentation/appstoreconnectapi/xcode_cloud_workflows_and_builds).
## Manual patches applied to OpenAPI Spec
The OpenAPI Spec provided by Apple do not always align with the data received from the API. Whenever such mismatches are identified, feedback is submitted to Apple and a patch is applied. Whenever an issue is resolved, the patch is removed again.
### Currently open feedback and applied patches
#### **FB8977648**: The "BundleIdPlatform" schema is missing "UNIVERSAL" and "SERVICES"
* Submitted: January 21st 2021.
* Updated: October 14th 2022 - the type "SERVICES" is also missing.
**Title:** App Store Connect API is missing the "UNIVERSAL" type for the BundleIdPlatform schema
##### Description
In the OpenAPI spec for the App Store Connect API the "BundleIdPlatform" schema is said to only be "IOS" or "MAC_OS". This is not right as universal apps (iOS and macOS) has a "UNIVERSAL" platform.
#### **FB12292035**: ErrorResponse.Errors has required optional "detail" and no "associatedErrors" in "meta"
* Submitted: June 9th 2023.
In Apple's OpenAPI spec the `detail` property on `ErrorResponse.Errors` is marked as `required`.
On 12/1/23 some errors (with status code 409) has been observed, with no `detail`.
In Apple's OpenAPI spec and documentation the `associatedErrors` is not mentioned in `meta` property (last checked 12/1/23).
But it is observed when creating a `ReviewSubmissionItem` with an `AppStoreVersion` fails.
#### **FB13701181**: App Store Connect API Spec is missing "DEVELOPER_ID_APPLICATION_G2" type for the Certificate Type schema
* Submitted: March 28th 2024.
In the OpenAPI spec for the App Store Connect API the “CertificateType” schema is said to not include "DEVELOPER_ID_APPLICATION_G2”. This is not right as “Certificates” endpoints can have a “DEVELOPER_ID_APPLICATION_G2” type.
When creating certificates on [the developer portal](https://developer.apple.com/account/resources/certificates/add), it is also possible to select the G2 Sub-CA (which corresponds to “DEVELOPER_ID_APPLICATION_G2”.
### Closed feedback (removed patches)
* **FB13540097**: Almost all of the schemas ending in “WithoutIncludesResponse” has wrong "data" type
* Submitted: January 14th 2024.
* Resolved: July 11th 2024 (Spec version 3.5).
* **FB9963088**: The xcodeMetrics schema has no properties or attributes in the OpenAPI spec
* Submitted: March 21st 2022.
* Resolved: July 12th 2022 (Spec version 2.0).
* **FB10029609**: Required 'links' property missing on included BuildBundle
* Submitted: May 27th 2022.
* Resolved: At least since May 23rd 2023.
* **FB13071298**: App Store Connect API Spec is missing "VISION_OS" type for the Platform schema
* Submitted: August 28th 2023.
* Resolved: January 25th 2024 (Spec version 3.2).
* **FB13539766**: App Store Connect API Spec is missing "APP_APPLE_VISION_PRO" type for the Screenshot Display Type schema
* Submitted: January 14th 2024.
* Resolved: January 25th 2024 (Spec version 3.2).