Header Ads Widget

Ticker

6/recent/ticker-posts

Revisión de herramientas: Swagger Inspector


 Las pruebas a menudo se consideran una consideración secundaria al final del ciclo de vida del desarrollo. El pensamiento común es que las API se prueban después de que se compilan y que cualquier problema encontrado debe abordarse durante estas etapas posteriores. Si bien este es ciertamente un método que puede entregar un producto terminado, al utilizar las pruebas de tal manera se pierden algunos de los principales beneficios de las pruebas anteriores . Todo lo que se necesita para obtener estos beneficios es una herramienta eficaz y poderosa para la inspección temprana , las pruebas y quizás incluso algunas características adicionales para completar la oferta.

Entra el inspector Swagger . Inspector es una nueva oferta en Swagger Hub que promete ser la " forma más fácil de probar y generar automáticamente documentación de OpenAPI para cualquier API ". Una nueva oferta en el ecosistema Swagger, la herramienta ha sido sometida a extensas pruebas beta y ahora se encuentra en una etapa que merece algo de atención.

Hoy, vamos a discutir sobre Inspector e identificar algunos puntos sólidos donde realmente brilla, así como algunas advertencias que deben considerarse antes de su adopción.

Pruebas de API en la nube

Uno de los principales beneficios de Inspector es que está centrado en la nube . La forma en que funciona el Inspector permite al usuario probar y validar API en la nube, en lugar de requerir que el usuario descargue una aplicación de escritorio o instale un complemento u otra solución basada en navegador. Esto es muy beneficioso, ya que permite realizar pruebas bajo demanda en cualquier ubicación.

Si bien esto tiene sus beneficios obvios en términos de experiencia del usuario, el cambio a la nube es en realidad parte de un gran cambio radical en la forma en que se manejan tales aplicaciones en la industria en su conjunto. La nube ya no es una tecnología "completamente nueva"; aunque queda mucho por hacer, la nube se ha convertido en la clave para muchas funciones comerciales y es casi omnipresente para los equipos de desarrollo de software modernos. Todo, desde el correo electrónico hasta el intercambio de documentos, desde el desarrollo hasta la documentación, tiene alguna opción en la nube para facilitar los esfuerzos de colaboración para un mejor producto final.

En pocas palabras, a medida que las API y la industria tecnológica en general se desplacen más hacia un enfoque basado en la nube, las pruebas de API también verán este cambio. Cuando la mayoría de las nuevas ofertas están en la nube, es muy difícil justificar una solución que no sea de la nube. Como tal, Inspector ofrece mucho en un entorno de nube muy atractivo.

Lea también: 9 errores comunes cometidos durante las pruebas de API

Generar documentación de OpenAPI

Uno de los mayores puntos de venta de la solución Inspector es la capacidad de generar automáticamente definiciones de OpenAPI desde cualquier servicio que el Inspector pruebe. Esta documentación, una vez generada, se puede transferir a SwaggerHub. OpenAPI tiene muchos beneficios en sí mismo, pero para muchos proveedores, la idea de cambiar a una nueva solución para una implementación ya existente es, en el mejor de los casos, abrumadora y, en muchos casos, impide que el servicio sea viable.

Inspector consumiendo la definición de API abierta de Petstore

Inspector soluciona esto automatizando completamente el proceso y almacenándolo en un centro colaborativo . Esto significa que Inspector no es solo una herramienta de inspección, sino que de hecho es una herramienta de Inspector que ofrece una mayor cantidad de resultados en una forma más dinámica y utilizable de lo que cabría esperar. Esto lo coloca muy por encima de otras ofertas que simplemente prueban. Dicho esto, no todo el mundo quiere utilizar la especificación OpenAPI. En estos casos, puede elegir si utilizar o no la herramienta según las necesidades de su organización.

Aprovechar esta solución para crear documentación también ofrece una experiencia unificadora. Muchos han "comprado" la experiencia Swagger, y dado que Inspector es en sí mismo parte del ecosistema Swagger, utilizarlo en las implementaciones de Swagger tiene sentido. Si bien esto podría ser en sí mismo un punto de venta por sí solo, cuando se combina con la generación de documentación de OpenAPI , se presenta un sistema y un flujo de trabajo verdaderamente unificados y se deben considerar para todos sus beneficios.

Relacionado: ¿Qué debe considerar antes de la adopción de OpenAPI?

Prueba casi cualquier cosa

Inspector está diseñado específicamente para permitir pruebas en una amplia gama de API, incluidas, de acuerdo con sus propios materiales de documentación, REST , SOAP y GraphQL . Esta base abierta para el soporte significa que Inspector no es tan limitante como otras soluciones de prueba, la mayoría de las cuales a menudo están diseñadas únicamente para el marco, la especificación, el idioma o la arquitectura dados.

Al utilizar este tipo de enfoque, Inspector se está posicionando para ser una ventanilla única para las pruebas de API y la generación de definiciones. Esta es una oferta muy necesaria en el espacio y presenta un cambio hacia un enfoque unificado en lugar de uno segmentado.

Una herramienta de prueba para la orientación del desarrollo

Inspector ofrece una experiencia unificada única que puede perderse a primera vista. Es tentador considerar que Inspector no es más que una herramienta de prueba, pero tiene más  propósitos múltiples de lo  que parece. En otras palabras, Inspector está preparado como una solución de prueba y generación, y como tal, considerarlo simplemente como una garantía de calidad o una solución de búsqueda de errores no tiene sentido.

Inspector proporciona una amplia generación durante las pruebas y, por esta razón, debería considerarse una herramienta que ayuda en el desarrollo . Una vez integrado en un ciclo de vida de desarrollo, Inspector se puede utilizar para generar documentación de OpenAPI como una función secundaria discreta, independiente de su función de prueba principal. La generación de documentación a lo largo del desarrollo es clave para encontrar no solo problemas con la base del código, sino también problemas en el enfoque que una organización adopta para la arquitectura API .

En consecuencia, Inspector ofrece una gran herramienta para pruebas tempranas que permite resolver problemas al tiempo que evita su propagación. Si el equipo tiene la intención de crear documentación, y sinceramente, debería hacerlo, entonces tiene más sentido hacerlo correctamente y hacerlo lo antes posible en el proceso para aprovechar estos beneficios.

Lea también: 7 elementos sin los que ninguna documentación de API puede vivir

Diseño y Experiencia

Si bien esto no es necesariamente un punto técnico, Swagger Inspector es simplemente genial de usar. La interfaz es extremadamente limpia, todo está claramente etiquetado y el diseño de la interfaz y los elementos web en sí están en línea con el resto de las ofertas del ecosistema Swagger. En pocas palabras, la inspectora es bonita .

Tema de luz del inspector

El diseño es similar a una férula. Pequeños y pequeños, nunca notarías la astilla de madera en una pila de leña, en una mesa o incluso en tu ropa. Sin embargo, si esa astilla llegara a su pulgar, sería obvio, deslumbrante y molesto. El diseño funciona exactamente de la misma manera: cuando el diseño de su interfaz de usuario es bueno, es poco probable que lo note. Cuando es malo, sin embargo, no solo interfiere con el uso y la experiencia del usuario, sino que puede resultar en una falla fundamental del flujo de trabajo del usuario.

La interfaz de Inspector es tan buena que es agradable de usar, y ese es un punto positivo importante que no se puede sobrevalorar.

Uso combinado con SwaggerHub

Un punto de venta importante para Inspector es el hecho de que se vincula directamente con SwaggerHub . SwaggerHub es una plataforma de diseño de API que permite el diseño de equipos colaborativos. La plataforma en sí ofrece una gran cantidad de integraciones, servicios, funciones y más, lo que la convierte en un producto digno de consideración.

El hecho de que Inspector se vincule directamente con SwaggerHub hace que este no sea solo un producto a considerar, sino un ecosistema a considerar en general. Si bien Swagger no siempre es la respuesta correcta a todos los problemas, y SwaggerHub tampoco es la respuesta correcta en todos los casos, el ecosistema en su conjunto es una muy buena opción para muchos equipos. El hecho de que Inspector se vincule con SwaggerHub debe considerarse un punto de apalancamiento que hace que la suma de los productos sea mayor que el total.

Es gratis

Una cosa a tener en cuenta es que Inspector es gratis y, según el material de marketing de SmartBear, su intención es mantenerlo así. Si bien ser gratuito no necesariamente hace que la implementación sea la mejor opción por sí sola, ciertamente endulza el trato. Una opción gratuita facilita el análisis de costo-beneficio, ofreciendo una gran cantidad de funcionalidad con una inversión muy baja en tiempo y energía.

Sin embargo, la prueba está en el pudín, y solo el futuro podrá mostrar si el aspecto gratuito es realmente un punto de venta. Si esta versión gratuita es limitada en el futuro, si una variedad paga se ofrece como una variante premium, y si el espíritu y enfoque general de SmartBear cambia, determinará si esto es una "cereza en la cima" o una consideración secundaria.

Habilitación del consumidor

Quizás el punto de venta más fuerte de Inspector es el hecho de que permite un consumo más completo y efectivo de una API . El usuario final no siempre tendrá acceso a su documentación, e incluso si lo tuviera, es posible que no funcione de la forma requerida o necesaria. En estos casos, los usuarios a menudo se encuentran abandonados a sus propios medios para descubrir los secretos de su API, lo que puede conducir a exposiciones desastrosas y funcionalidad de ruptura.

Cuando usa Inspector, lo arregla de dos maneras. En primer lugar, al utilizar la generación de documentación de la especificación OpenAPI , está creando un conjunto de documentación estandarizado y fácil de navegar para sus usuarios que niega muchos de los problemas mencionados anteriormente. Más concretamente, como usuario, utilizar Inspector le da una idea de la API en cuestión y expone mucha más información que las pruebas ab básicas a través de prueba y error.

Inspector permite el consumo de la API de una manera más interactiva y beneficiosa.

Caveat Emptor

Dicho todo esto, hay ciertos casos en los que Inspector, o más específicamente la documentación de OpenAPI que genera, no es la mejor opción. Dos casos particulares que me vienen a la mente son los siguientes.

  • Las API privadas , especialmente aquellas que no están destinadas al consumo público, pueden optar por no utilizar Inspector debido a la naturaleza de sus integraciones OpenAPI y SwaggerHub. Debido a que estas API están diseñadas para ser consumidas por usuarios específicos, que generalmente están capacitados en la propia API, estos materiales no son apropiados en tales casos.
  • Del mismo modo, las API internas que deben adherirse al ciclo de vida de desarrollo en cascada tradicional , donde las pruebas se realizan en una etapa específica, pueden no beneficiarse de todo lo que Inspector tiene para ofrecer. Si bien todavía pueden usar Inspector en la etapa final, el hecho es que sería similar a usar un martillo neumático para quitar un padrastro, técnicamente factible, pero un poco exagerado por decir lo menos.

Conclusión

Inspector es una excelente opción para muchos equipos, dado que el equipo ve beneficios tanto en los materiales de OpenAPI que ofrece como en la naturaleza de su enfoque de prueba. Si bien no todas las API se beneficiarán de su adopción, o para el caso de la adopción de OpenAPI o SwaggerHub, muchas API podrían, y solo por esta razón, debe considerarse como una posible solución.

Dicho esto, cada API es individual en sus requisitos: los sistemas que necesita para funcionar, su enfoque para las pruebas e incluso su espíritu de diseño general. En consecuencia, Inspector puede ser su herramienta ideal, asumiendo, por supuesto, que su problema es el que intenta resolver.

Publicar un comentario

0 Comentarios