Giter Club home page Giter Club logo

exgen's Introduction

exgen

Easily generate examples for your api using existing unit tests.

NOTE: Packages of this monorepo are still under heavy development. Use with caution.

Motivation

Writing examples of how to consume your api is crucial but its a difficult process. We need to make sure that the examples match the latest version of the api and at the same time it should be guaranteed that the examples are using tested code. If you have added unit tests for your api, then that itself can act as a source of documentation. Because when you write tests you are aware of the side-effects of the function, what the function returns or what it takes as arguments. Why not use that as part of your official documentation. By writing your tests in a certain way this library can automatically detect which functions need to be documented and how using your test assertions.

Packages

exgen's People

Contributors

devorein avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.