0.0
No commit activity in last 3 years
No release in over 3 years
Generates Markdown documentation from YAML discovery file.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
 Project Readme

discoverydoc

Gem Version Build Status

Generate markdown document from discovery file.

From following YAML Dicovery file,

service:
  name: BookService
  id: com.example.book_service
  base_url: http://example.com/book_service/api

endpoint:
  ListBook:
    path: GET /books
    response: [Book]
  GetBook:
    path: GET /books/{id}
    response: Book
  PostBook:
    path: POST /books
    body: Book
    response: Book
  PatchBook:
    path: PATCH /books/{id}
    body: Book
    response: Book
  SearchBook:
    path: GET /books/search
    params:
      query: String
    response: [Book]

entity:
  Book:
    title: String
    author_name: String
    published_at: Date

error:
  id: String
  message: String
  url: String

Following markdown documentation is generated.


BookService Service

Base URL

http://example.com/book_service/api

Endpoint

GET /books (ListBook)

Response

Array(Book)

GET /books/{id} (GetBook)

Response

Book

POST /books (PostBook)

Response

Book

PATCH /books/{id} (PatchBook)

Response

Book

GET /books/search (SearchBook)

Parameters

Field Type
query String

Response

Array(Book)

Entity

Book

Field Type
title String
author_name String
published_at Date