create-go-app VS swagger-ui

View on GitHub

Hello, friends! 😉 I'm excited to share great news with you: the Create Go App CLI project, that I've been working on for a long time, has finally been updated to major version 2.

# ./hosts.ini # Ansible inventory for deploy the Create Go App project. # Author: Vic Shóstak (https://shostak.dev) # For more information, please visit https://create-go.app/ [cgapp_project] 127.0.0.1 # CHANGE THIS TO YOUR REMOTE SERVER IP! [cgapp_project:vars] # # Ansible default variables to start playbook: # # Set remote sudo username ansible_user=root # Ask become password for remote sudo user ansible_become=yes # Set connection type to remote server (usually, 'ssh') ansible_connection=ssh # Set Python 3 default path ansible_python_interpreter=/usr/bin/python3 # # Remote server configuration: # # Set directory on your remote server # for store project files server_dir=/var/www/cgapp # Set user (owner of files/folders) name server_user=root # Set group name server_group=docker # # Project configuration: # # Set your project domain project_domain=example.com # # Docker configuration: # # Set Docker network name docker_network=cgapp_network # # Backend configuration: # # Set backend port number, # MUST BE MATCH to the port that is listed # in your `./backend/.env` file! backend_port=5000 # # PostgreSQL configuration (backend DB): # # Set PostgreSQL version (for example, 13.2) postgres_version=latest # Set PostgreSQL port number, # MUST BE MATCH to the port that is listed # in your `./backend/.env` file! postgres_port=5432 # Set PostgreSQL user name, # MUST BE MATCH to the user name that is listed # in your `./backend/.env` file! postgres_user=postgres # Set PostgreSQL password, # MUST BE MATCH to the password that is listed # in your `./backend/.env` file! postgres_password=password # Set PostgreSQL DB name, # MUST BE MATCH to the DB name that is listed # in your `./backend/.env` file! postgres_db=postgres # Set PostgreSQL SSL mode state ('enabled' or 'disabled'), # MUST BE MATCH to the SSL mode state that is listed # in your `./backend/.env` file! postgres_ssl_mode=disable # # Go-Migrate configuration: # # Set migration number, # if you WANT to migrate all of your migrations, # just leave it blank, # for only initial migration set it to '1' migrate_number=1 # # Redis configuration (backend cache): # # Set Redis version (for example, 6.2) redis_version=latest # Set Redis port number, # MUST BE MATCH to the port that is listed # in your `./backend/.env` file! redis_port=6379 # # Nginx configuration: # # Set Nginx version (for example, 1.20-alpine) nginx_version=alpine # Set redirect from HTTP to HTTPS for default server nginx_use_only_https=yes # Set redirect from WWW to non-WWW domain for default server nginx_redirect_to_non_www=yes

Hey, DEV friends! 👋 Today, I'd like to introduce a new version of my own project Create Go App CLI, that changes some fundamental things.

Swagger is a fantastic open-source toolset that's perfect for developing and describing RESTful APIs. It offers you a user-friendly interface to understand a service's capabilities without needing to dig into the code. It even provides a way for you to interact directly with the API, which means you get to test its functionality.

The API had an OpenAPI endpoint built with Swagger where I could download a JSON specification file for the API.

Swagger is a widely used tool for documenting and testing APIs.

Swagger is an open-source software framework that implements the OpenAPI Specification—an API description format for REST APIs. The OpenAPI Specification defines a standard, language-agnostic interface to HTTP APIs, enabling both humans and computers to discover and understand the capabilities of the API.

Mocking and Testing: Once the API design is complete, developers create mock APIs to simulate the behavior of the actual services. This early testing phase helps identify any issues or mismatches between design and implementation before substantial development efforts are invested. Tools like Postman or Swagger are invaluable for API testing and validation.

import fp from "fastify-plugin"; import swagger from "@fastify/swagger"; export default fp(async (fastify) => { fastify.register(swagger, { openapi: { info: { tags: [ { name: "drinks", description: "Drink-related endpoints", externalDocs: { description: "Find out more", url: "http://swagger.io", }, }, ], }, }, }); });

A very requested feature for Sharkio was the auto-generation of OpenAPI documentation using the recorded HTTP requests - to create standardized documentation.

Automation QA is a lot of the same duties as manual QA, but instead of writing and executing the test plans manually, we create and update automated tests that can run those validations programmatically, for example by using Selenium to automatically fill out and submit forms for a web application, or using Postman and/or Swagger to generate an API conversation test.

The code below is now roughly from memory and my controller would usually look something like this (Swashbuckle or NSwag attribute hints removed). There are some gotchas with Swagger and SwaggerUI for supporting multipart/form-data which I haven't included here since they now be fixed, since it's been a while since I checked.