Changes between Initial Version and Version 1 of swager


Ignore:
Timestamp:
Jun 10, 2022, 9:28:36 AM (22 months ago)
Author:
irina
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • swager

    v1 v1  
     1[[PageOutline(2-5,Índice)]]
     2
     3= Uso de swager para probar la API REST de OpenGnsys =
     4
     5La API REST de OpenGnsys está documentada con swager que crea automáticamente un listado de ejemplos de  la funciones que nos permiten utilizarlas y nos muestra la orden que debemos usar con curl.
     6
     7Antes de usar una función hemos de autenticarnos. Para ello vamos a la función/url de login.
     8
     9En el ejemplo ponemos el usuario por defecto de OpenGnsys.
     10
     11[[Image(APIREST-000.png)]]
     12
     13Al pulsar “Try it” nos muestra el comando que ha utilizado y nos devuelve el token para autenticar las comunicaciones que hagamos con el servidor:
     14
     15[[Image(APIREST-002.png)]]
     16
     17En la parte de arriba de la página pulsaremos “Authorize”, nos aparecerá un formulario donde incluiremos la API KEY que nos ha dado el paso anterior.
     18
     19
     20[[Image(APIREST-004.png)]]
     21
     22A partir de ahora todas las consultas contendrán el token.
     23
     24Como ejemplo vamos a consultar los repositorios que tiene configurado nuestra unidad organizativa.
     25
     26[[Image(APIREST-006.png)]]
     27
     28En el único campo que pide pondremos el identificador de nuestra unidad organizativa. Al dar a “Try it out” devolverá los repositorios que tenemos dados de alta.
     29
     30
     31[[Image(APIREST-008.png)]]
     32
     33
     34
     35
     36
     37Observamos que en el apartado “Curl” el comando que envía incluye el token de autenticación.