/custom-api-doc

Proyecto Realizado en Angular que permite Generar la documentacion en formato propio a partir de un simple formulario y genera los parametros a aprtir de la url y el body json

Primary LanguageTypeScript

Build App

$ ng build -op dist/example
$ ng build --output-path=dist/example

$ ng build --prod --base-href http://localhost/HttpRequests/ --deploy-url http://localhost/HttpRequests/ --output-path=/c/IISApps/HttpRequests

--base-href indica la url base para nuestras paginas de nuestra aplicacion, y --deploy-url indica la carpeta bajo la cual nuestra aplicación encontrará los recursos necesarios para su ejecución

Extracted from https://qastack.mx/programming/51182322/whats-the-difference-between-base-href-and-deploy-url-parameters-of-angular

Configurations

La siguiente configuracion permite que se resuelva un problema ocurrido con typescript que forzaba a las variables a ser inicializadas.

Especificamente ocurria con esta linea de codigo.

// app.component.ts
@ViewChild('user') userInput: ElementRef;
// tsconfig.json
    "lib": [
      "es2018",
      "dom"
    ],
    > "strictPropertyInitialization": false <
  },
  "angularCompilerOptions": {

Github Authentication

$ git remote set-url origin https://alejogtz:<token>@github.com/alejogtz/custom-api-doc.git

$ git push -u origin master

Información extraida de una pregunta en stackoverflow https://stackoverflow.com/questions/18935539/authenticate-with-github-using-a-token

Deploy to Github Pages

Siguiendo la guia de https://angular.io/guide/deployment

// build project to docs dest folder and set `--base-href` as your project page url
$  ng build --prod \
  --output-path docs \
  --base-href https://alejogtz.github.io/custom-api-doc/

// Push to gh-pages branch
$ git add . && \
  git commit -m 'Deployed to Gh-pages' && \
  git push origin gh-pages:gh-pages &&

Extensiones de VS