An API for the World’s Largest Model Repository

An API and the world’s largest searchable model repository are in the works.

News July 2014: API V1 released

Every day, thousands of people in the world design software. Just like you and me, thousands of programmers and software architects design use cases, classes, packages, etc. to give their code the best chance to match requirements and to reduce bugs. But how many of us actually share our knowledge?

Hypermedia Model API

Agile modeling means lightweight tools and interoperability. People want to use their design models in several environments.  APIs have become the best way to make tools work together.

A first version of the GenMyModel API will be out before this summer. The V1 will provide the basics:

  1. OAuth2 authentication
  2. Get and store the models
  3. Pull and push model changes through commands
  4. Real-time notifications
rest model API commands

 

Our intent is not to restrict the model repository and its API to UML. Any kind of XMI-based model and its metamodel can be stored. We are fascinated by the environment initiated by Github with their API. Open source projects, editors and individuals have created their own tools to tackle Git repositories in their own ways. That’s what we want to do for software modeling.

What would you expect from this API? Drop us an email if you have any ideas.

Model Explorer

The Model Explorer will display public models on genmymodel.com/explore. 25% of the models created within GenMyModel are public, and there are plenty of open source projects. Showing public models will help start new projects and create references for documentation.

A search engine using Amazon CloudSearch will allow you to search for models by titles, length, tags, etc. similar to what Github does. The search engine will also be accessible by the API.  After finding a project you’d like to fork, a webpage will provide specifics about the project. We’ve been working on the webpage design to showcase your models.

Here’s is screenshot of this page:

model-explorer-mockup

Communities using shared repositories have existed for a decade. It’s now time for modeling to catch up to this trend. That’s what we dream about here, and that’s what we’re doing: bringing you the tools to share the awesome designs you create.

Post Update – July, 7 2014

A first version of the hypermedia API has just been released!

Example: https://api.genmymodel.com/users/examples

API docs (draft) : https://api.genmymodel.com/doc

genmymodel UML api example

 

GenMyModel API

Tweet about this on TwitterShare on FacebookShare on Google+Share on LinkedIn

About the author

Tom Team

GenMyModel co-founder - @tomlegrd