kfang / easydocs

Easier API Documentation

##Currently Under Maintenance Please see the github issues for things that need to happen.

• upgrade to using scala.js for the frontend
• upgrade to using akka-http form spray.io
• use upickle instead of spray-json

##Http Endpoints ###Sites

• GET /api/sites
• POST /api/sites
  • ex: {"name":"my-site-name"}
• GET /api/sites/:id

###Site Topics

• **GET /api/sites/:id/topics

###Endpoint

• GET /api/endpoints/:id
• POST /api/endpoints
  • authentication is optional
  • parameters is optional

  {
      "site":"my-site-id",
      "topic":"route-topic",
      "subTopic":"route-subtopic",
      "notes":"stuff to know about the route (supports markdown)",
      "route":"/the/api/route",
      "method":"GET",
      "contentType":"application/json",
      "authentication":"required",
      "parameters":"stuff about the request params or body (supports markdown)"
  }

• PUT /api/endpoints/:id
  • its the same as creating a promotion except you can't change site
• DELETE /api/endpoints/:id

easydocs's Issues

Addressable Resources

Would be nice

migrate to akka-http

switch to using pegdown and generate the HTML from markdown on the server side

remove elasticsearch aliasing

it just makes the code complicated...

Layered drop down on sidebar

Can only read 10 subtopics per topic on the sidebar

CORS support

need cors support in order to make ajax requests from other hosts.

generate public docker image

start using scala.js so that models can be shared

This involves a lot of steps:
1. setup a multi-project build with shared, jvm, js
2. move models into a shared project for js and jvm
3. figure out a good way to package everything together into docker