https://github.com/jonico/octodex-rest-api

Octodex REST API
https://github.com/jonico/octodex-rest-api

api json octocat octodex postbot postman

Last synced: 3 months ago
JSON representation

Octodex REST API

• Host: GitHub
• URL: https://github.com/jonico/octodex-rest-api
• Owner: jonico
• License: apache-2.0
• Created: 2023-10-08T01:43:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-01T14:43:37.000Z (over 1 year ago)
• Last Synced: 2025-01-14T02:32:27.626Z (5 months ago)
• Topics: api, json, octocat, octodex, postbot, postman
• Language: JavaScript
• Homepage: https://www.postman.com/postman/workspace/fun-apis-only
• Size: 156 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Octodex REST API

[![Postman API Tests](https://github.com/jonico/octodex-rest-api/actions/workflows/postman-governance.yml/badge.svg)](https://github.com/jonico/octodex-rest-api/actions/workflows/postman-governance.yml)

There is no official REST API for the [Octodex ](https://octodex.github.com) \- GitHub's home of Octocat illustrations and the place where superfans can find and share their favorite designs.



JSON is so much easier to work with than HTML, so why not create your own Octodex REST API that returns JSON? We have already created a Postman [API Mock Server](https://learning.postman.com/docs/designing-and-developing-your-api/mocking-data/setting-up-mock/) and copied all the tests and visualizations created by Postman in this request. Once you have created your real backend, just replace the value of the `baseUrl` collection variable with the URL of your own server and run the tests again.

If you are interested in how you can design your own APIs with Postman, version them in GitHub, include CI/CD and generate server boilerplate code, [check out Postman's documentation](https://learning.postman.com/docs/designing-and-developing-your-api/the-api-workflow/).



## OpenAPI 3.0 Generated NodeJS Express

This project contains generated code from an OpenAPI 3 definition.

The project integrate the NodeJS express library and is ready to run stand alone as a service.

To run this project:

```

npm install

npm run start

```