Documentación y ajustes de un API REST

Ortiz Suaña, Nicolás (2018). Documentación y ajustes de un API REST. Proyecto Fin de Carrera / Trabajo Fin de Grado, E.T.S. de Ingenieros Informáticos (UPM), Madrid, España.

Descripción

Título: Documentación y ajustes de un API REST
Autor/es:
  • Ortiz Suaña, Nicolás
Director/es:
  • Herranz Nieva, Ángel
Tipo de Documento: Proyecto Fin de Carrera/Grado
Grado: Grado en Ingeniería Informática
Fecha: Junio 2018
Materias:
Palabras Clave Informales: API REST; Coowry; RAML; Nunjucks; HTML; PDF; DOcumentación; Automático; Cliente; Documentation; Automatic; Clients
Escuela: E.T.S. de Ingenieros Informáticos (UPM)
Departamento: Lenguajes y Sistemas Informáticos e Ingeniería del Software
Licencias Creative Commons: Reconocimiento - Sin obra derivada - No comercial

Texto completo

[img]
Vista Previa
PDF (Document Portable Format) - Se necesita un visor de ficheros PDF, como GSview, Xpdf o Adobe Acrobat Reader
Descargar (1MB) | Vista Previa

Resumen

Este trabajo de fin de grado se basa en la documentación del API REST de Coowry utilizando RAML como lenguaje de modelado del API REST. Dicha documentación dará lugar al ajuste de la documentación del API actual una vez realizadas las correcciones oportunas. La documentación permitirá la generación automática de documentación del API. Una vez modelado el API REST mediante RAML, y haciendo uso de templates de Nunjucks, podremos generar de manera automática la documentación tanto para su visualización en una página web (HTML) como en PDF, de modo que cualquier cambio en el API REST se realice únicamente en el modelado en RAML.---ABSTRACT---This end-of-grade project is based on the documentation of Coowry REST API using RAML as modeling language of the REST API. This documentation will lead to the adjustment of current API’s documentation once the appropriate corrections have been done. The documentation will allow the automatic generation of API documentation. Once we have modeled the REST API using RAML, and using Nunjucks templates, we can automatically generate the documentation both for viewing on a web page (HTML) and in PDF, so that any change in the REST API is done only in RAML modeling.

Más información

ID de Registro: 51601
Identificador DC: http://oa.upm.es/51601/
Identificador OAI: oai:oa.upm.es:51601
Depositado por: Biblioteca Facultad de Informatica
Depositado el: 12 Jul 2018 05:21
Ultima Modificación: 12 Jul 2018 05:21
  • GEO_UP4
  • Open Access
  • Open Access
  • Sherpa-Romeo
    Compruebe si la revista anglosajona en la que ha publicado un artículo permite también su publicación en abierto.
  • Dulcinea
    Compruebe si la revista española en la que ha publicado un artículo permite también su publicación en abierto.
  • Recolecta
  • InvestigaM
  • Observatorio I+D+i UPM
  • OpenCourseWare UPM