5m
API Creators
A core part of your platform API strategy is enabling developers to quickly add new capabilities to your APIs that can be utilized by anyone in the oganization. There are a lot of things you can do to try and make this process easier, but it there are a couple steps that give a large return on your investment:
- Template - Give developers an amazing "file new" experience with a goal of starting them off where they can only think about building what was assigned for their first feature.
- Local development tools - Developers need to build and test things locally. Ideally the happy path here is integrated into your tempaltes
- Self-service to production - Developers can ship their features to production without having manual intervention or lengthy review processes.
The Anatomy of a delightful template
- Clear documentations, typically in the form of a
README.md
file at the root of the repo that descibes what the template does - Integrated CI/CD workflows for things liketesting and deploying the API
- Boilerplate code for each getting started (i.e. linting, buildingm internal best practices, deployment)
- Simple getting started and usage
- MAINTENANCE!!! - This is the most important part of the template. If the template is not maintained, it will not be used. Simpler is better, pick 1-2 or maybe 3 languages to initially support in youir platform API.
Share your questions and comments about this lesson
Your feedback helps us improve! If you're stuck or confused, let us know and we'll help you out. All comments are public and must follow the Apollo Code of Conduct. Note that comments that have been resolved or addressed may be removed.
You'll need a GitHub account to post below. Don't have one? Post in our Odyssey forum instead.