Analysis of Tools for REST Contract Specification in Swagger/OpenAPI

Jéssica Santos, Leonardo Azevedo, Elton Soares, Raphael Thiago, Viviane Silva

Abstract

REST is a resource-based architectural style that has emerged as a promising way for designing Web services. A REST API exposes services’ functionalities through a contract that allows consumption by different clients. The contract specifies service’s request and response schemes and related rules the service and the client should comply with. The process of documenting and keeping an API consistent is a time consuming human effort. The documentation should reflect the implementation which may evolve. This work compares different tools for REST APIs specifications. We focused on tools that automatically generate Swagger (Open API in version 3.0), a specification for designing REST APIs. We evaluated the tools using a set of criteria whose results may help software engineers to choose the most appropriate tool, and point out gaps for research initiatives.

Download


Paper Citation


in Harvard Style

Santos J., Azevedo L., Soares E., Thiago R. and Silva V. (2020). Analysis of Tools for REST Contract Specification in Swagger/OpenAPI.In Proceedings of the 22nd International Conference on Enterprise Information Systems - Volume 2: ICEIS, ISBN 978-989-758-423-7, pages 201-208. DOI: 10.5220/0009381202010208


in Bibtex Style

@conference{iceis20,
author={Jéssica Santos and Leonardo Azevedo and Elton Soares and Raphael Thiago and Viviane Silva},
title={Analysis of Tools for REST Contract Specification in Swagger/OpenAPI},
booktitle={Proceedings of the 22nd International Conference on Enterprise Information Systems - Volume 2: ICEIS,},
year={2020},
pages={201-208},
publisher={SciTePress},
organization={INSTICC},
doi={10.5220/0009381202010208},
isbn={978-989-758-423-7},
}


in EndNote Style

TY - CONF

JO - Proceedings of the 22nd International Conference on Enterprise Information Systems - Volume 2: ICEIS,
TI - Analysis of Tools for REST Contract Specification in Swagger/OpenAPI
SN - 978-989-758-423-7
AU - Santos J.
AU - Azevedo L.
AU - Soares E.
AU - Thiago R.
AU - Silva V.
PY - 2020
SP - 201
EP - 208
DO - 10.5220/0009381202010208