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.

Description

Title: Documentación y ajustes de un API REST
Author/s:
  • Ortiz Suaña, Nicolás
Contributor/s:
  • Herranz Nieva, Ángel
Item Type: Final Project
Degree: Grado en Ingeniería Informática
Date: June 2018
Subjects:
Freetext Keywords: API REST; Coowry; RAML; Nunjucks; HTML; PDF; DOcumentación; Automático; Cliente; Documentation; Automatic; Clients
Faculty: E.T.S. de Ingenieros Informáticos (UPM)
Department: Lenguajes y Sistemas Informáticos e Ingeniería del Software
Creative Commons Licenses: Recognition - No derivative works - Non commercial

Full text

[img]
Preview
PDF - Requires a PDF viewer, such as GSview, Xpdf or Adobe Acrobat Reader
Download (1MB) | Preview

Abstract

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.

More information

Item ID: 51601
DC Identifier: http://oa.upm.es/51601/
OAI Identifier: oai:oa.upm.es:51601
Deposited by: Biblioteca Facultad de Informatica
Deposited on: 12 Jul 2018 05:21
Last Modified: 12 Jul 2018 05:21
  • Logo InvestigaM (UPM)
  • Logo GEOUP4
  • Logo Open Access
  • Open Access
  • Logo Sherpa/Romeo
    Check whether the anglo-saxon journal in which you have published an article allows you to also publish it under open access.
  • Logo Dulcinea
    Check whether the spanish journal in which you have published an article allows you to also publish it under open access.
  • Logo de Recolecta
  • Logo del Observatorio I+D+i UPM
  • Logo de OpenCourseWare UPM