Skip to content

Commit d058f1d

Browse files
committed
quick note on laravel oas 3.1
1 parent 593af54 commit d058f1d

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

openapi/frameworks/laravel.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -748,4 +748,4 @@ As you can see, a lot more information is provided which will help anyone who wa
748748

749749
## Summary
750750

751-
Generating an OpenAPI specification for your Laravel API is a great way to improve developer experience and streamline API consumption after the API has been built. When API design-first is not an option, "catching up" with Scribe means you can quickly get to the point of having a complete OpenAPI document that can be used in tools like Speakeasy to generate SDKs, tests, and more.
751+
When API design-first is not an option, "catching up" with Scribe means you can quickly get to the point of having a complete OpenAPI document without having to duplicate a lot of information. Let the code do the talking, and enable tools like Speakeasy to generate SDKs, tests, and more.

openapi/frameworks/rails.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Learn how to generate OpenAPI specifications for your Rails App us
55

66
# How to generate OpenAPI documentation with Rswag for Ruby on Rails
77

8-
When building APIs in your Ruby on Rails application you're already fully onboard with "Convention over Configuration", building RESTful routes is a standard for most Rails developers, so is writting tests using Test Driven Development (TDD), but creating an OpenAPI document that accurately describes your API is another matter.
8+
When building APIs in your Ruby on Rails application you're already fully onboard with "Convention over Configuration", building RESTful routes is a standard for most Rails developers, so is writing tests using Test Driven Development (TDD), but creating an OpenAPI document that accurately describes your API is another matter.
99

1010
[The OpenAPI Specification](https://swagger.io/specification/) (formerly Swagger) has become the industry standard for documenting RESTful APIs, but manually writing and maintaining OpenAPI documents can be a time-consuming and error-prone process.
1111

@@ -27,7 +27,7 @@ The idea behind Rswag is simple: You write RSpec tests that describe what your A
2727

2828
### Wait, what's RSpec?
2929

30-
[RSpec](https://rspec.info/) is a Ruby testing framework, that lets you write tests for your code. Specificly [rspec-rails](https://github.com/rspec/rspec-rails) brings RSpec testing to your Rails application. RSpec has a DSL (Domain Specfic Language) that lets you write tests in a way that is easy to read and understand. Rswag builds on this with its OpenAPI-based DSL to describe your API endpoints and then generate the OpenAPI document from your spec tests.
30+
[RSpec](https://rspec.info/) is a Ruby testing framework, that lets you write tests for your code. Specifically [rspec-rails](https://github.com/rspec/rspec-rails) brings RSpec testing to your Rails application. RSpec has a DSL (Domain Specific Language) that lets you write tests in a way that is easy to read and understand. Rswag builds on this with its OpenAPI-based DSL to describe your API endpoints and then generate the OpenAPI document from your spec tests.
3131

3232
### So, to summarize:
3333

0 commit comments

Comments
 (0)