npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

open-library-api

v0.1.2

Published

Open API specs, docs, and generated typescript client for the Internet Archive's Open Library API.

Downloads

60

Readme

open-library-api

NOTE: this is not an official Open Library package. openlibrary.org does not currently provide an official package.

open-library-api is a node module that includes Open API Spec definitions for the openlibrary.org API. It is based on the reference python library provided by the Internet Archive. The json schema was updated by hand and then generated into typescrupt defs using openapi-typescript. To import the types in node, just:

  1. Install the library: npm install open-library-api
  2. Import the types: import { paths, components, operations } from 'open-library-api'

Getting Started - browsing the documentation

This repository comes with an Open API Spec viewer powered by RapiDoc. To browse the Open API documentation, clone this library:

  git clone [email protected]:Candid-Engineering/open-library-api.git

Then run npm start and open http://localhost:3000 in your favorite browser.

Getting Started - node typescript client

While you may use the included OAS specs to generate an Open Library client in any language (e.g. by using openapi-generator), the recommended approach for Node + TypeScript is to use openapi-fetch:

openapi-fetch is a type-safe fetch client that pulls in your OpenAPI schema. Weighs 5 kb and has virtually zero runtime. Works with React, Vue, Svelte, or vanilla JS.

Using it is as simple as:

  1. npm install open-library-api
  2. npm install openapi-fetch
  3. Create and use an openapi-fetch client using the open-library-api definitions:
import createClient from 'openapi-fetch'
import type { paths } from 'open-library-api'


const client = createClient<paths>({ baseUrl: 'https://openlibrary.org/' })

const { data, error, response } = await client.GET('/isbn/{isbn}.json', {
  params: { path: { isbn: '1234567890' } }
})

That's it, have nerdy 📖🐛 fun!

Future Work

The current implementation only documents the basic GET APIs for /author/{id}, /book/{id} (aka /edition/{id}), and /work/{/id}. It also covers Edition lookup by ISBN: /isbn/{isbn}.

Features that are not currently included in this spec:

Contributions Welcome!

Feel free to open Pull Requests with additional open-library features.