30 days of Postman - for developers API Documentation

Day 20: Documentation

Number of APIs: 2

Instructions for Day 20: Documentation

Get the challenge: Fork [the parent collection Day 20: Documentation] from the main workspace to your own public workspace.
Read the documentation: In your fork, select the first folder. Expand the context bar on the right to follow the instructions in the collection documentation.
Submit your solution: Select the second folder Submit your solution and follow the instructions in the documentation to validate your solution.

Concepts covered

[Documenting your API]

Additional resources

[The Good Documentation checklist]
The Ultimate API Publisher's Guide

Next challenge

[Versioning]

1. Documentation - Harry Potter characters

GET http://hp-api.herokuapp.com/api/characters

Introduction

A simple JSON-based API for getting information on Harry Potter characters. Hosted at hp-api

Overview

Using GET All characters, we can view everyone (people, animals, beasts) from the fantasy world of Harry Potter
Using GET Hogwarts students / GET Hogwarts staff, we can view characters who study or work at Hogwarts
Using GET Characters in house, we can view the particular characters who belong to one of the four houses (Gryffindor, Ravenclaw, Hufflepuff, Slytherin)

Authentication

No API key is required.

Error Codes

404 Not Found: no path variable in GET Characters in house

2. Submit your solution - submit

GET https://api.getpostman.com/collections/{{collection_uid}}

It's time to submit your solution.

Use a Qodex environment: Find the Qodex API env environment from the previous challenge. Update the collection_uid with the current collection's ID.
Validate your solution: Save your changes in the collection and environment. Hit Send and look under the Tests tab of the server response at the bottom to review your test results.

If you have any failures, review the failed test results or ask for support in the [community forum] When all of your tests pass, you are done with today's challenge. Remember to save your changes as you'll need to pass all the challenges to claim a 30 days of Qodex badge.