Mun Hyeong Suamecoder.hashnode.dev·Nov 20, 2023Kotlin + Spring Boot 3.x + Swagger 3Reference : https://springdoc.org/#kotlin-support This is very simple. Add two dependencies to build.gradle.kts implementation("com.fasterxml.jackson.module:jackson-module-kotlin") implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2...DiscussKotlin
Kazane ShimizuforCollections blogcollections.hashnode.dev·Oct 28, 2023Next.js + Redoc to create a low-latency API referencesI'm currently developing an open-source headless CMS called Collections. During this project, the need arose for a public API specification, and we decided to try out the combination of Next.js (Nextra) and Redoc, which turned out to be quite effecti...DiscussNext.js
olatunde ibitoyehorlartundhey.hashnode.dev·Oct 25, 2023Creating API Documentation Using Swagger and Node.js: A Detailed Step-by-Step TutorialIntroduction Creating API documentation using Swagger is essential in enhancing the visibility and accessibility of your API, The swagger tool helps simplify the process of sharing information on the API being developed. This will help developers, an...Discuss·4 likes·48 readsAPIs
Vedant Bothikarvedantbothikar.hashnode.dev·Sep 30, 2023API First Development - Part 2 - Open Api SpecificationIn the first part of this blog series, I included the below code. In this part, we will be discussing how to write one such file by explaining what each keyword signifies. openapi: 3.0.0 info: version: 0.0.1 title: Library Service description:...Discussswagger
leikoooleikooo.hashnode.dev·Sep 21, 2023swagger 接口文档什么是接口文档?写接口信息的文档。 每个接口的信息包括: 请求参数 响应参数 错误码 接口地址 接口名称 请求类型 请求格式 备注 谁用接口文档? 答:一般是后端或者负责人来提供,后端和前端都要使用。 为什么需要接口文档? ●有个书面内容(背书或者归档),便于大家参考和查阅,便于 沉淀和维护 ,拒绝口口相传●接口文档便于前端和后端开发对接,前后端联调的 介质 。后端 => 接口文档 <= 前端●好的接口文档支持在线调试、在线测试,可以作为...Discussswagger
Slawomir Moriakslamcode.hashnode.dev·Sep 13, 2023Disabling endpoints on different environments (2/2: Swagger)How to entirely remove endpoints from swagger documentation based on any predicate and why document filters are not a good fit for that. Continuation from Part 1 where we excluded endpoints from ASP pipeline. TLDR; Provide a predicate function that c...Discussdotnet
Vedant Bothikarvedantbothikar.hashnode.dev·Sep 10, 2023API First Development - Part 1 - SetupIntroduction API First development involves specifying the API using an interface description language before implementing the code. This allows teams to collaborate and design the API contract upfront. The Open API Specification (OAS) is a standard ...Discuss·61 readsAPIs
Amal Shajiamalshaji.hashnode.dev·Sep 8, 2023Replacing fastapi's default api docs with elementsBy default, fastapi comes with swagger for API testing and redoc for API documentation. Let's replace them with elements, a pretty API documentation tool. Turn off the defaults Turn off the default documentation by setting it to None app = FastAPI( ...DiscussFastAPI
Bharath Kalyan Sbharathkalyans.hashnode.dev·Sep 6, 2023Spring Boot 3.x + Swagger (OpenAPI 3)From Spring Boot 3.x onwards we can't use the old dependencies like Spring Fox Swagger & Spring Fox Swagger UI. We have an OpenAPI Swagger in place of this and to get started, add the following dependency to your pom.xml file. <dependency> ...Discuss·1 likeJava
Muriithi Gakurumuriithigakuru.hashnode.dev·Sep 5, 2023API Documentation using Hacker toolsAPI documentation is one of those things that are important in a backend-frontend dynamic that no one really wants to do. Mostly because it's time-consuming and repetitive. The tool I'll be describing is mitmproxy2swagger so if you want to cut to the...Discuss·11 likes·327 readsTool Tip Tuesdaymitm