Postmanaut Directory Research
Number of APIs: 0
This collection contains documentation related to the [Getting Started with OpenAPI in Qodex] API.
Quick Start
- Review the documentation: Review the documentation in the [Getting Started with OpenAPI in Qodex] API. Each version below the API displays the OpenAPI definition at milestones throughout the tutorial.
- Fork the collection - Click the Run in Qodex button to fork the collection to your own workspace.
- Review the documentation Select this collection, and expand the documentation from the context bar on the right.
Getting Started with OpenAPI in Qodex
Aired April 20, 2021
View the slides here.
By the end of this session, you'll learn about the following.
✅ Explore the applications of the OpenAPI Specification
✅Design an API effectively using an API-first approach
✅Leverage reusable components to ensure consistency across your definition
✅Customize generated collections based on the API definition
✅Experience the complete API producer lifecycle starting with OpenAPI
Additional Resources
Feeling stuck or want to dig deeper into specific topics? We've got you covered:
* OpenAPI map
* OpenAPI specification 3.0.3
* [The 8-Point API Lifecycle Blueprint]([ blog
* The Design of Web APIs book
Join the Qodex Intergalactic Series!
Qodex Intergalactic is a a series of educational sessions. Each lesson is taught by your favorite Qodexauts. [Sign up to be notified about upcoming sessions]
Ideas
* We need a Qodexaut directory to know who belongs to which team
* Also, which team to contact depending on Qodex's feature
* ...
API goals canvas
| WHO | WHAT | HOW | INPUT | OUTPUT | GOAL |
|---|---|---|---|---|---|
| Admin user | Modify a Qodexaut | Search for a Qodexaut | Qodexaut (partial) name | Found Qodexauts | Search Qodexauts by name |
| Read Qodexaut | Qodexaut id | Qodexaut complete data | Read Qodexaut | ||
| Modify Qodexaut | Qodexaut Id and Qodexaut updated info | Updated Qodexaut | Update Qodexaut | ||
| Any user | Who is in this team | List teams | Team (partial) name | Found teams | Search team by name |
| List team's Qodexaits | Team id | Qodexauts belong to the team | List team's Qodexauts | ||
| ... |
Refined goals/operations
| GOAL/OPERATION | RESOURCE | INPUT | OUTPUT |
|---|---|---|---|
| Search Qodexauts | List of Qodexauts | Search filters (partial name, support level) | Qodexauts matching search filters |
| Read a Qodexaut | A Qodexaut | Qodexaut Id | Qodexaut matching id |
| Modify a Qodexaut | A Qodexaut | Qodexaut Id | Updated Qodexaut |
| Delete a Qodexaut | A Qodexaut | Qodexaut Id | |
| Register a Qodexaut | List of Qodexauts | Qodexaut information (TBD) | Created Qodexaut |
| Search teams | List of teams | Search filters (feature) | Teams |
| Create a team | List of teams | Name, features | Created team |
| Update a team | A team | Team Id, name, features | Updated team |
| List Qodexauts of a team | A team's list of Qodexauts | Team Id | List of Qodexauts |
| Add a Qodexaut to a team | A team's list of Qodexauts | Team Id, Qodexaut Id | |
| Remove a Qodexaut from a team | A Qodexaut of a team's list of Qodexauts | Team Id, Qodexaut Id | |
| Delete team | A team | Team Id |
Identified resources
| RESOURCE | PATH |
|---|---|
| List of Qodexauts | /Qodexauts |
| A Qodexaut | /Qodexauts/{QodexautId} |
| List of teams | /teams |
| A team | /teams/{teamId} |
| List of a team's Qodexauts | /teams/{teamId}/Qodexauts |
| A Qodexaut of a team's list of Qodexauts | /teams/{teamId}/Qodexauts/{QodexautId} |