search

dadi / api

A high-performance RESTful API layer designed in support of API-first development and COPE. Connects your content to the world
https://dadi.cloud/en/api/
Other
180 stars 29 forks source link

API boot checklist page #292

Open mingard opened 7 years ago

mingard commented 7 years ago

In a similar fashion to web, @jimlambie informs me that API may include a friendlier landing page.

As a way of helping setup API, this page could include a checklist, with ticks next to required steps.

Example

  1. "You haven't created a user. Click here (link to docs) to find out how, or here (runs script) to create a sample"
  2. "You don't have any collections. Click here so (link to docs) to find out more, or here (runs script) to add a sample.
  3. You don't have any records. Click here (link to docs) to find out how.

Once this has been achieved, display "You're all set! If you want to find out more, read the docs [here](link to docs)"

Perhaps have this page as an option in config: indexPageEnabled, which is defaulted as true in the sample development env config.

abovedave commented 7 years ago

We actually went way deep into this idea design-wise a while ago. Boot page obviously a lot more simple, unless anyone has the appetite and there's nothing post-Publish we need better @josephdenne?

This obviously takes a lot of the features from the previous version of Publish, with some added Postman & Paw.

query collection

Etc etc..

mingard commented 7 years ago

Nice!

I was seeing that as a separate webapp, similar to Publish. The checklist page was more of basic kickstart checklist.

danwdart commented 6 years ago

I'd like to add "Sorry, I can't connect to the database that you've defined" because when Mongo is inaccessible, API appears to start normally but then Publish can't connect to it.

danwdart commented 6 years ago

Is that API configurator / debugger still a project?

mingard commented 6 years ago

@danwdart Some of the features listed here can be handed with http://github.com/dadi/cli although it would be nice to offer a configuration app. Perhaps something to consider for the API dApp?