Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

defapi-client

v0.1.0

Published

3 years ago

Client server for viewing defapi api definitions

Downloads

4

0High
0Medium
0Low

defapi-client

Client server for viewing defapi api definitions.

Prerequisites

defapi

Core library for defining your api endpoints to be viewed by defapi-client. Install defapi in your api project. See the README for usage info.

$ npm install defapi

CLI

You can use the defapi-client cli during local development to view the api definitions of your service project.

Install

$ npm install defapi-client

Usage

$ defapi-client serve

# Options
# --baseUri - The base uri of your service.
# --port - The preferred port on which to serve your api definitions

Self Hosted Usage

Clone the repo
Run: $ defapi-client init. This creates a defapi.sources.js file (see sample-defapi.sources.js for sample contents).
Edit the defapi.sources.js file for each of your api sources that you want to be captured by defapi-client. You might consider using environment variables to determine what urls will be configured for each source based on the target environment (e.g. development, staging or production).
Make other desired changes to the project (names, docker setups, other configuration).
Host your defapi-client project.

Change Logs

0.1.0-beta

$ defapi-client init command to create the sources file.
defapi.sources.js - Specify baseUri of the source instead of manifestUrl. manifestUrl is now discarded from defapi.sources.js.
$ defapi-client serve - Allow user to specify preferred port by passing --port option.
Client: Link to refresh api manifest