OpenAPITools / OpenAPITools/openapi-generator

MirageJS openAPI Generator

Open
#4,936 1 comment 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

What is it?

MirageJS is an API mocking library that lets you build, test and share a complete working JavaScript application without having to rely on any backend services.

People use mirage to develop locally when their server is not done/not finished so they can do all the normal work as if they're working with a real API but they're going against mirage. It provides an in memory database that enables to CRUD features while simulating the behaviour of the server, all in the client.

In the last couple of months, we noticed that some of the problems people had adding mirage to the problem were mostly around all the boilerplate that it is needing to get the project working with it. Even though it can be added incrementally for only a part of the endpoints, having mirage simulating all the endpoints adds even more value.

How does it relates with open API?

We've started this miragejs-open-api that is a generator of mirage code based on the openAPI standard, it is still a work in progress but it looks like we can do interesting stuff with it and we're putting effort in.

@wing328 reached out to me and I now believe that it could fit as an open API generator, would like to hear your feedback.

Does it make sense? Does it not? What needs to be done in order to get a fully compliant open api generator?

Excited to hear from you

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked miragejs-open-api project and the OpenAPI standard. No repository files, tests, or entry points are named; done would require a defined scope for integrating or evaluating a fully compliant MirageJS generator.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.