Swift Api Design Guidelines
CheckedHelps with Swift, API, design as part of building frontend UIs and user experiences workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add gu7araujo/swift-api-design-guidelines-skill --skill swift-api-design-guidelines -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
gu7araujo
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned gu7araujo/swift-api-design-guidelines-skill at 50f16bf473.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 50f16bf473
- Manifest
- SKILL.md
- Scanned
- 4 files, 250 lines
About this skill
What it does
This skill provides guidance and recommendations for designing robust and user-friendly Swift APIs. It leverages Apple's official API Design Guidelines to ensure consistency, clarity, and maintainability in your Swift code. The skill can help with naming conventions, documentation generation, error handling, and overall API structure.
When to use it
- You are starting a new Swift project and want to establish clear API design principles from the outset.
- You're refactoring existing Swift code to improve its usability and maintainability.
- You need help ensuring your public APIs adhere to Apple’s recommended practices for iOS, macOS, watchOS, or tvOS development.
- You are onboarding new developers to a project and want to provide them with consistent API design guidelines.
Key capabilities
- Adherence to Apple's official Swift API Design Guidelines.
- Recommendations on naming conventions for methods, properties, and types.
- Guidance on generating clear and concise documentation.
- Suggestions for effective error handling strategies within APIs.
Example prompts
- "How should I name this method that calculates the average of an array?"
- "What are best practices for documenting a Swift struct?"
- "Give me examples of how to handle errors in my API."
Tips & gotchas
This skill assumes familiarity with basic Swift programming concepts. While it provides guidance, ultimately you'll need to apply the principles and make design decisions based on your specific project requirements.