apicollective / ui Goto Github PK

View Code? Open in Web Editor NEW

12.0 6.0 4.0 2.51 MB

UI for https://www.apibuilder.io

Home Page: https://ui.apibuider.io

License: MIT License

JavaScript 82.28% CSS 17.03% EJS 0.69%

apidoc react redux api apis api-service apibuilder

ui's Introduction

apidoc-ui

A fresh UI built using React + Redux for https://github.com/mbryzek/apidoc

Preview

Dev

UI Dev

yarn install
yarn start
http://localhost:8080/

yarn test
yarn flow

Before a Pull Request

yarn run check

App

yarn start

Deploy

Deploy will build and push to S3. You need to have ~/.aws/credentials setup with access to the S3 bucket for this

yarn deploy

Build Settings

APIDOC_HOST

Location of the apidoc api, examples:
- http://somehost.com/api
- /custom-api-route

PREFIX

prefix for js and css assets. Defaults to /
- /assets

TITLE

The default title is APIDOC, this can be customized for a deployment
If specified this removes the github icon and link

Example:

> APIDOC_HOST='/my-api' PREFIX='/assets' TITLE='My Company' yarn build

ui's People

Contributors

Stargazers

Watchers

Forkers

jackyzhen movio sanayafai sshyran

ui's Issues

When on a resource or model page the side nav should have current page highlighted

Resource Content changes

Remove Application name/description from all resource content pages.
Replace with Resource Card for specific operation

JsonDoc should have good defaults

Use default value
or example
or name of field
or 123
or first value in enum

JsonDoc should display arrays with [ ]

Fix Navbar link staying highlighted after mouseout

Add Model to Field description in JsonDoc

Clicking on a resource that has been exported from another application doesn't work

When clicking on a field within a resource that has been exported by another application, there is an error and the app becomes unresponsive.

(index):37 Uncaught TypeError: Cannot read property 'name' of undefined

JsonDoc when a field doesn't have a description - clear documentation

JsonDoc Enum hover is not working

ApplicationHome changes

Add descriptions to ResourceCards

Model / Enum pages should state if they are enums or models (possibly with visual + color)

Lists of operations on the application intro page should be clickable

Some of the Movio operations don't work

http://localhost:8080/org/movio.cinema/app/cinema-core/r/Cinema/m/post/p/v2tenantcinema

Add Enum support to Models Page

Currently model details only support 'Model' not 'Enum'

Remove descriptions from the Org's page

Org's can't have descriptions

Put back pretty icons

Put back the icons in the side bar.

SideBar changes

Link to original api.json and service.json

It would be nice to have a link to the original json and service json file.

Improve loading page

Support generic documentation

We should add support for organisation level documentation which is markdown. A json file will be reading containing:

[{org:"movio.cinema", name: "High level doc", link: "link to github file (markdown)"}]

Or something similar, this would be rendered on the sidebar in a Organization and the git repos would be pulled down manually.

Handle spec imports

Request/Response types should be clickable

if a request/response returns a model/enum you should be able to click it.

Change all box line widths to 2px

Revert blue h1 background to white

The descriptions will have markdown and code in them, so we should revert this to standard.

Add `... / GET /url/:param` to NavBar

When on an operation page the Top Nav should have the Operation displayed

Consumption of markdown

Links of help:

Markdown parser - supports Github flavour
Injecting raw HTML in React

Higher level documentation

Documentation Link
Make sure links conform to new app

Fade long sidebar items if they are too long

When navigating to a new app, the old app is (spec) is displayed for a bit

Detect when changing app - display a spinner and fade in new app

Make sidebar header sticky on scroll

Fade in/out loading page

Description in resources should go underneath JsonDoc

The body parameter in resources should have the description underneath the JsonDoc

Add request body documentation for PUT and POST endpoints

Sort out imports navigation

Should we navigate to the actual import spec? APIDoc does currently.

Imports clutter the sidebar if there's a lot.
Do we need a link on an imported model page to take you to the actual spec?

Types of Fields in ParameterList's should be clickable to Model Page

Can't link directly to operations

http://localhost:8080/org/movio.cinema/app/cinema-core/r/HealthCheck/m/get/p/_internal_healthCheck

All descriptions should support markdown formatting

Org
App
Resource
Model
Fields

Implement documentation section for headers

An api.json can specify the required and optional headers used by that service.

When on a model page the top nav should have the Model name displayed

Scroll down to active sidebar item on location change

Change hover colour of Navbar links to be darker

Top nav should have white "/" and should align with new design

Add description + card layout + styles for Org/App

Create new component that has title + description of Org/App

Hosting non-locally

Hover is broken

When hovering over a field within a resource, hover doesn't show over the resource properly