surveylegend / hapi-docs Goto Github PK
View Code? Open in Web Editor NEWBeautiful API documentation generator for Hapi using Vue
License: MIT License
Beautiful API documentation generator for Hapi using Vue
License: MIT License
It seems that the documentation generator ignores important items such as:
Would be great to support these!
The hapi ecosystem migrated to scoped packages a few days ago and all the other packages have been deprecated. I think your dependencies needs to be updated.
If I have some time this weekend I'll try to put up a PR.
How can I generate code examples and example responses?
If you attempt to run this on a project without the Inert plugin installed, the plugin fails to run. This appears in your integration example but is not explicitly documented :)
the stacktrace is here:
{ AssertionError [ERR_ASSERTION]: Unknown handler: directory
at new AssertionError (internal/assert.js:269:11)
...
If you try to switch language on the Demo, nothing happens.
Thanks for this beautiful library in advance!
I couldn't find which directory I should place my logo. I created /src/assets/images/logo.png path in my root directory, it didn't work. Can you help me with this?
From the usage instructions of hapi-docs
:
If you want a route to appear in the documentation, you have to set tags: [api] for this specific route.
I find this really annoying, for a few reasons:
tags : ['api']
to every single API route individually, of which I have a large number. Adding these tags is tedious./api
prefix in the URL, as many people do, to delineate which routes are APIs. The tag needlessly duplicates this information.api
tag to any route that I want to document, even if the route is not an API. Thus, the tag is actually nonsensical.What I really want is to document all routes by default, the way that lout does. Or at least make it easy to document all routes under the /api
URL prefix at once, without adding tags to each individual route.
It would be very useful if there was a way to document "extra information", such as how to build CDN urls, for example.
I would suggest this is added much like errors, auth, etc, as an array of optional pages which could be inserted into the docs, i.e:
{ plugin: HapiDocs,
options: {
pages: [
{
name: 'CDN Urls',
title: 'Some page title here'
descriptions: [
"Some different pararaphs go here",
"Relating to the subject matter"
]
}
],
...
}
}
Hello,
When I install version 0.4.0 some files are not found on the /docs route. I assume that this is a bug. Thanks for not starting the Vue App. I get the same problem on the Docs Example page.
I've fixed this in my fork but I'm not a Vue user so I'm not sure it's the correct fix.
You'll get this error trying to install:
npm ERR! code 1
npm ERR! path /home/ant/Projects/hapi-docs
npm ERR! command failed
npm ERR! command sh -c vue-cli-service build
npm ERR! A complete log of this run can be found in:
npm ERR! /home/ant/.npm/_logs/2021-02-25T09_17_44_566Z-debug.log
❯ npm install --save-dev @vue/cli-service@latest
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: @surveylegend/[email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/vue
npm ERR! vue@"^2.6.12" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer vue@"3.0.6" from @vue/[email protected]
npm ERR! node_modules/@vue/compiler-sfc
npm ERR! peerOptional @vue/compiler-sfc@"^3.0.0-beta.14" from @vue/[email protected]
npm ERR! node_modules/@vue/cli-service
npm ERR! dev @vue/cli-service@"4.5.11" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR! See /home/ant/.npm/eresolve-report.txt for a full report.
npm ERR! A complete log of this run can be found in:
npm ERR! /home/ant/.npm/_logs/2021-02-25T09_18_18_185Z-debug.log
Regressing @vue/cli-service
to v4.4 will remove the dependency on Vue 3 and allow the project to build.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.