Git Product home page Git Product logo

untypeable's Introduction



❗️
@untypeable




A lot of RESTful API's are not typed, let's type them

Tests status

❓ What is @untypeable?

@untypeable is a collection of packages built around the untypeable package, which allows you get type-safe access to any API.

In this case we are doing the heavy lifting by creating type definitions for all the most popular API's out there. This way you are able to use your favourite RESTful API's with complete type safety.

📦 Packages

The following are all currently supported @untypeable packages. Click on one below to view it & read more on how to install & use it.

🏃‍♂️ Examples

If you want to see an example of any of the packages in action & being used, have a look in the examples/ directory to view a simple script that uses untypeable & whatever package we've built to see what it looks like.

If however you want to actually run any of those examples to prove they work, simply run the following command & select the example you want to run:

# npm
npm run example

# yarn
yarn run example

# pnpm
pnpm run example

untypeable's People

Contributors

nurodev avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

untypeable's Issues

Add Changesets

Currently we don't have any nice or easy method to manage deploying new versions of packages.
After a bit of research the recommended project to use is Changesets, especially for monorepos like Turborepo.

This means we will likely need to add some kind of config and/or files to the repo, including a GitHub action.

Add SpaceX API support

We need to add support for the open source SpaceX API

  • Capsules
    • /v4/capsules
    • /v4/capsules/:id
  • Company Info
    • /v4/company
  • Cores
    • /v4/cores
    • /v4/cores/:id
  • Crew
    • /v4/crew
    • /v4/crew/:id
  • Dragons
    • /v4/dragons
    • /v4/dragons/:id
  • Landpads
    • /v4/landpads
    • /v4/landpads/:id
  • Launches
    • /v4/launches
    • /v4/launches/next
    • /v4/launches/last
    • /v4/launches/:id
    • /v4/launches/upcoming
    • /v5/launches
    • /v5/launches/next
    • /v5/launches/last
    • /v5/launches/:id
    • /v5/launches/upcoming
  • Launchpads
    • /v4/launchpads
    • /v4/launchpads/:id
  • Payloads
    • /v4/payloads
    • /v4/payloads/:id
  • Roadster info
    • /v4/roadster
  • Rockets
    • /v4/rockets
    • /v4/rockets/:id
  • Ships
    • /v4/ships
    • /v4/ships/:id
  • Starlink
    • /v4/starlink
    • /v4/starlink/:id
  • History
    • /v4/history
    • /v4/history/:id

Add JSONPlaceholder support

We need to add support for the JSONPlaceholder API

  • Albums

    • GET /albums
    • POST /albums
    • GET /albums/:id
    • GET /albums/:id/comments
    • PUT /albums/:id
    • PATCH /albums/:id
    • DELETE /albums/:id

  • Comments

    • GET /comments
    • POST /comments
    • GET /comments/:id
    • GET /comments/:id/comments
    • PUT /comments/:id
    • PATCH /comments/:id
    • DELETE /comments/:id

  • Photos

    • GET /photos
    • POST /photos
    • GET /photos/:id
    • GET /photos/:id/comments
    • PUT /photos/:id
    • PATCH /photos/:id
    • DELETE /photos/:id

  • Posts

    • GET /posts
    • POST /albums
    • GET /albums/:id
    • GET /albums/:id/comments
    • PUT /albums/:id
    • PATCH /albums/:id
    • DELETE /albums/:id

  • Todos

    • GET /todos
    • POST /todos
    • GET /todos/:id
    • GET /todos/:id/comments
    • PUT /todos/:id
    • PATCH /todos/:id
    • DELETE /todos/:id

  • Users

    • GET /users
    • POST /users
    • GET /users/:id
    • GET /users/:id/comments
    • PUT /users/:id
    • PATCH /users/:id
    • DELETE /users/:id

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.