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

loopback-json-schema-builder

v0.0.8

Published

Converts loopback models into a json schema model file

Downloads

1,353

Readme

LoopBack JSON Schema Builder

This module can create json schema objects based on loopback models.

This is useful if you want to quickly create forms for your loopback models using something like angular schema form.

CLI Usage

node . (path to loopback root)/server/server.js

returns to console out a map of all schema models

API

###loadAllModels(app, options) loads schema for all loopback models associated with the given loopback app. Options is currently unused.

returns a map of model name to model schema

###loadModel(model)

returns a jsonSchema

integrate with remote methods

var schemaBuilder = require('loopback-json-schema-builder');
module.exports = function (BaseModel) {
...

  BaseModel.jsonSchema = function(cb) {
    const schema = schemaBuilder.loadModel(BaseModel.modelName, this);
    cb(null, JSON.stringify(schema, null, 2));
  }

  BaseModel.setup = function() {
    // We need to call the base class's setup method
    BaseModel.base.setup.call(this);
    var BaseModelInternal = this;

    BaseModelInternal.remoteMethod(
      'jsonSchema',
      {
        description: 'Get the json schema for the given loopback model.',
        accessType: 'READ',
        returns: {arg: 'schema', type: 'string', root: true},
        isStatic: true,
        http: {path: '/json-schema', verb: 'GET'}
      }
    );

  }
...

}

NOTE: This module only does loopback models TO json schema. If you are looking at going from json schema TO loopback models, checkout this neat project loopback-jsonschema