Skip to content

Commit

Permalink
fix: fix api configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Nov 9, 2019
1 parent 89684ac commit ec67b63
Show file tree
Hide file tree
Showing 192 changed files with 5,585 additions and 2,189 deletions.
2 changes: 1 addition & 1 deletion Layout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
},
mounted () {
getApi(this.$site.themeConfig.apiUrl)
// getApi(this.$site.themeConfig.apiUrl)
window.addEventListener('scroll', this.onScroll)
Expand Down
132 changes: 83 additions & 49 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ module.exports = {
title: 'Ts.ED',
description: 'A TypeScript Framework on top of Express',
serviceWorker: false,
extendMarkdown (md) {
md.use(require('../../plugins/markdown-it-symbol'))
},
themeConfig: {
version: require('../../package').version,
repo: 'TypedProject/ts-express-decorators',
Expand All @@ -14,20 +11,11 @@ module.exports = {
editLinks: true,
docsDir: 'docs',
sidebar: 'auto',
apiUrl: '/api.json',
plugins: [
[
'@vuepress/google-analytics',
{
ga: 'UA-35240348-1'
}
]
],
api: require('../api/api'),
algolia: {
apiKey: 'f8a038207e461aaac0e2fd16403c2b01',
indexName: 'ts_ed'
},

locales: {
'/': {
label: 'English',
Expand All @@ -49,55 +37,66 @@ module.exports = {
text: 'Configuration',
link: '/configuration.html'
},
{
text: 'Docs',
items: [
{
text: 'Overview',
items: [
{ link: '/docs/controllers.html', text: 'Controllers'},
{ link: '/docs/providers.html', text: 'Providers' },
{ link: '/docs/model.html', text: 'Models' },
{ link: '/docs/converters.html', text: 'Converters' },
{ link: '/docs/middlewares.html', text: 'Middlewares' },
{ link: '/docs/filters.html', text: 'Filters' },
{ link: '/docs/interceptors.html', text: 'Interceptors' },
{ link: '/docs/authentication.html', text: 'Authentication' },
{ link: '/docs/hooks.html', text: 'Hooks' }
]
},
{
text: 'Advanced',
items: [
{ link: '/docs/injection-scopes.html', text: 'Injection scopes' },
{ link: '/docs/custom-providers.html', text: 'Custom providers' },
{ link: '/docs/custom-endpoint-decorators.html', text: 'Custom endpoint decorators' },
{ link: '/docs/testing.html', text: 'Testing' },
{ link: '/api.html', text: 'Api Reference' }
]
}
]
},
{
text: 'Guide',
type: 'links',
items: [
{ link: '/tutorials/', text: 'Examples' },
{ link: '/tutorials/session.html', text: 'Session & cookies' },
{ link: '/tutorials/passport.html', text: 'Passport.js' },
{ link: '/tutorials/typeorm.html', text: 'TypeORM' },
{ link: '/tutorials/mongoose.html', text: 'Mongoose' },
{ link: '/tutorials/graphql.html', text: 'GraphQL' },
{ link: '/tutorials/seq.html', text: 'Seq' },
{ link: '/tutorials/socket-io.html', text: 'Socket.io' },
{ link: '/tutorials/swagger.html', text: 'Swagger' },
{ link: '/tutorials/ajv.html', text: 'Validation with AJV' },
{ link: '/tutorials/upload-files-with-multer.html', text: 'Upload files' },
{ link: '/tutorials/multer.html', text: 'Upload files' },
{ link: '/tutorials/serve-static-files.html', text: 'Serve static files' },
{ link: '/tutorials/templating.html', text: 'Templating' },
{ link: '/tutorials/throw-http-exceptions.html', text: 'Throw HTTP exceptions' },
{ link: '/tutorials/aws.html', text: 'AWS project' }
]
},
{
text: 'Documentation',
items: [
{ link: '/docs/controllers.html', text: 'Controllers' },
{ link: '/docs/services.html', text: 'Services' },
{ link: '/docs/factory.html', text: 'Factory' },
{ link: '/docs/provider.html', text: 'Provider' },
{ link: '/docs/model.html', text: 'Models' },
{ link: '/docs/converters.html', text: 'Converters' },
{ link: '/docs/middlewares.html', text: 'Middlewares' },
{ link: '/docs/scope.html', text: 'Scope' },
{ link: '/docs/filters.html', text: 'Filters' },
{ link: '/docs/interceptors.html', text: 'Interceptors' },
{ link: '/docs/server-loader.html', text: 'ServerLoader' },
{ link: '/docs/testing.html', text: 'Testing' }
{ link: '/tutorials/not-found-page.html', text: 'Customize 404' },
{ link: '/tutorials/aws.html', text: 'AWS project' },
{ link: '/tutorials/jest.html', text: 'Jest' }
]
},
{
text: 'Api Reference',
link: '/api.html'
}
{ text: '4.x', link: 'http://v4.tsed.io' }
],

sidebar: {
'/docs/middlewares/': [{
title: 'Middlewares',
collapsable: false,
children: [
'global-middleware',
'global-error-middleware',
'endpoint-middleware',
'endpoint-error-middleware',
'call-sequence',
'override-middleware',
'override/authentication',
Expand All @@ -112,15 +111,25 @@ module.exports = {
title: 'Overview',
collapsable: false,
children: [
'provider',
'model'
'controllers',
'providers',
'model',
'converters',
'middlewares',
'filters',
'interceptors',
'authentication',
'hooks'
]
},
{
title: 'Advanced',
collapsable: false,
children: [
'scope'
'injection-scopes',
'custom-providers',
'custom-endpoint-decorators',
'testing'
]
}
],
Expand All @@ -131,26 +140,33 @@ module.exports = {
collapsable: false,
children: [
'',
'session',
'passport',
'typeorm',
'mongoose',
'graphql',
'socket-io',
'seq',
'swagger',
'ajv',
'custom-validator',
'multer',
'serve-static-files',
'templating',
'throw-http-exceptions',
'aws'
'not-found-page',
'aws',
'jest'
]
}]
},

otherTopics: [
'/tutorials/session',
'/tutorials/passport',
'/tutorials/typeorm',
'/tutorials/mongoose',
'/tutorials/graphql',
'/tutorials/socket-io',
'/tutorials/swagger',
'/tutorials/ajv',
Expand All @@ -159,18 +175,22 @@ module.exports = {
'/tutorials/serve-static-files',
'/tutorials/templating',
'/tutorials/throw-http-exceptions',
'/tutorials/not-found-page',
'/tutorials/aws',
'/tutorials/jest',
'/tutorials/seq',
'/docs/controllers',
'/docs/services',
'/docs/factory',
'/docs/provider',
'/docs/providers',
'/docs/model',
'/docs/converters',
'/docs/middlewares',
'/docs/scope',
'/docs/filters',
'/docs/interceptors',
'/docs/server-loader',
'/docs/authentication',
'/docs/hooks',
'/docs/injection-scopes',
'/docs/custom-providers',
'/docs/custom-endpoint-decorators',
'/docs/testing'
],

Expand All @@ -186,6 +206,20 @@ module.exports = {
documentationGeneratedWith: 'Documentation generated with'
}
}
},
plugins: [
[
'@vuepress/google-analytics',
{
ga: 'UA-35240348-1'
}
]
]
},
markdown: {
lineNumbers: true,
extendMarkdown: md => {
md.use(require('../../plugins/markdown-it-symbol'))
}
}
}
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---

sidebar: false
---
# Api Reference

Expand Down
Binary file added docs/assets/client-controllers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/hooks-in-sequence.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile modified="2019-09-07T17:35:01.718Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:69.0) Gecko/20100101 Firefox/69.0" etag="ltlYbG0JN62H6yaLLz6L" version="11.2.6" type="device" pages="1"><diagram id="DG_1D_lNAm6PYI5epRoH" name="Page-1">7VxZc9s2EP41mmkfnOF9PFqWY2eaTjJ20yZPHYiEJCYQwYDQ5V9fgCR4gjIbSaQl+8VDLIElsLvfYncBeaTfLLd3BESLP7EP0UhT/O1In4w0zTUs9pcTdinBsJ2UMCeBn5LUgvAYPMGMqGTUVeDDuNKRYoxoEFWJHg5D6NEKDRCCN9VuM4yqX43AHDYIjx5ATeo/gU8XKdXR7IJ+D4P5QnxZtdz0zRKIztlK4gXw8aZE0m9H+g3BmKZPy+0NRFx2Qi7puPctb/OJERjSLgOsT3dfft49fLHviAWVh4/rv6l+pWeTWwO0ylaczZbuhAhg6F9zSbJWiENGHPsgXkDOVmWNBV2i7DEdCv2GSIs5qvnKmcVAvISU7FiXTSFbM5vSoiRWQSMQARqsq+xBpuJ5zi7/wmccsA9rSmaNmpPxyYzRcWosYrwiHsxGlWX5DCNDqfKhgMwhbfBhD6VVF6REU3KtkSvverJ7MpYP93982D08fdp+/ffKbuqIyfwxa2JCF3iOQ4BuC+qY4FXoJ0pTWKvo8xHjKFPfd0jpLoMgWFFcVS7cBvQrH/7OzFrfSm8m24xz0tiJRsgWWhrEm9/K74phSUuMiynBP+ANRpgk69MVxTZ8NzexhkUxYSSq2yM0VWqdTVM80MbUmmmoer+2oTYAzVwjk+fKo0yYdbsprIIrcrMIKHyMQCLHDfPnVQto18oMh/Q9WAaIL/oeojWkgQf2qWsNCYXbvYoQb9UaaLNmyWWohsRn1OVeVl1F6P9Xws4b+hrq7B1VVk27XT13g5HTMzw1yYZrTOEME/ghDOiREWp5DpzOOEIDhEp0H0Bn5vWM3NwV9gFdabijXfzO2aZnKaYnBaafD9o6bLFCbymG9oWdBzqJg/y3NOa1EJvveMoe5vwBYeBzPuF3mO6b7FPKdBUgTo0IXrOshPDJhX6afDDxIgRJLDixmeXMjoxp33anikTXsxm0vL4xnYfmJUzrvWK6GfAIHTDJBT9goQUDh6mLzVVU76HkQ1eRoP6m/p6bBym6FjyKri/MeTe02ikVa3PefcZdckUb5+K8OzvhXMO/5oTbfWsHH2z25IP3TfJFZSkHwUWvwUVXnXfm0IC5+Eylr2inHUAdgFaq9g2ANFOWb4iN8HK2qwb+LHN4/CkNCb9Q/LX7zF9F5hFxJsr+JZztieuPX3qw3WrEW7eXzqWHGiPdPVnpQS5HmStIw1g/WNcjW3kEXI93WYbEOVppglTyLApcw2TxMSTrJFXaBMkUpzBRyRKvoZ8nUARGiPsZ9nqX8ilXRPYE35KJS0jPD63BlPkhWkUVgXHwBKZJB27fEddSojdzPDInjMKRGKeg5AMACuYhe0Zwxllx58acHbrOyJSjeRwz7xqE878SaF8Zx3GFrlkxM9dtBu6G0qcf1PVz8YNHrZhORMyZTVE1j+wX7a4BiDNkACKmKat4PuAVhfGlxSL11NlUZLFIv1USUzsXDA6DJfcksUP9nNg+3UHxnmXVsQdmFJLXAT3L1QeHXm6ELx56Z5mGi/s1z26D6UY01DYopimBIr10FBr68Mm47p4LCgfZALWuZWN90GBSaxaO82DyYxBTGF4yjmzHHngvMy5+LxsGfUZH9GmDntqIaUr2sMsHn+PoQweSLbX8Bwj83WGi71OQrq4OHpMbZ3OWfF5+zOnoxwxtUD/mSIAkvwFEkjT5DG71HLdiZRoDA1Rvv9aTFO4VUV9n1J8r/huKsccWy08aRLte8+cCrGhMdOQvrtLS/TXroFrRtp1Lrv9HcbDBF6op11GEmD5ogEO5teS0dB5DnUdkUhryRELotpwL2hLj0k5mXFqrcR3ZSD5nVwVbPEiLTbwg7cs3i8OO6vVnzcHt0xqEX3uLBY57D61rLJBmFYPdROsSC2TJTX6Y/bqiAUcfOhow3yB6CogaWtdwfdDSuZhmI+99FUdYpiu7Sdoz/t7KfifBX9cbHAcfTx+GP9kNDnm6HFM2H49FuwqDzuvLmy3x7w6GQ+rZ3LUaBnFu16C0r5+o7Z3mPsQBnwPuDuEp4PxuCeG/nFDuQeijpC6xDHz2tGFSem0wzK/ZnACGrFn8z470nk7xj0/02/8A</diagram></mxfile>
Binary file modified docs/assets/hooks-in-sequence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/assets/middleware-call-sequence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/middleware.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile modified="2019-06-13T09:48:25.934Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:67.0) Gecko/20100101 Firefox/67.0" etag="zNQGLAyjXp85JX7BV83r" version="10.7.7" type="device"><diagram id="-pNohHKRrXRFJF8rd36P" name="Page-1">5VZNc5swEP01nmkPngFkY3yMidtMJzm0PjRXBa1BiWCpEAb311cYiY+QeJJp04/phZHe7rK7b/UEMxKm9UdJ8+QGGYiZ57B6Ri5nnrd2A/1sgGMLLIkBYslZC7k9sOPfwYCOQUvOoBg5KkSheD4GI8wyiNQIo1JiNXbboxhnzWkME2AXUTFFv3KmkhYNvFWPXwGPE5vZ9detJaXW2XRSJJRhNYDIdkZCiajaVVqHIBruLC9t3IdnrF1hEjL1kgD1KaK3F/Po9vMqvNhfX9X7ZD4n7VsOVJSmYVOsOloGgGlCzBalSjDGjIptj24klhmDJo2jd73PNWKuQVeD96DU0UyXlgo1lKhUGGuhJD5AiALlKSdxnNXict1ZLPOas01bX1PUszwYqMBSRnCmeXueqIxBnfHzumnpUw6YgpJHHSdBUMUP4zqoOW9x59ePRC/MVF4xIXcyoVDwplXP+QLfSijUZGL9PBpyq4Qr2OX0REWlRfqz3B9AKqjPsz9lywZYOZj7IDDbqhdX55IMhOU7b8Tv8n9WgPdCBSz+pAK8yYRuOGMCKt3wLz77gXdHfF9b9lyIAc6WELDFW2mC/G2aWDyhCV/orBvGD3oZN8ttxnLkzUXUmnSmgfWJgHfS3lf645jnPIvfW687+Tju8dv+oStu+fvGqbf9D8TJNvgLI9sf</diagram></mxfile>
2 changes: 2 additions & 0 deletions docs/assets/middleware.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ec67b63

Please sign in to comment.