api
π Automatic SDK generation from an OpenAPI definition
νμΌ νμκΈ°
μ΅μ’ λ²μ λ€μ΄λ‘λ (.zip)- config.json
- README.md
- ci.yml
- codeql-analysis.yml
- docs.yml
- lint-pr-title.yml
- smoketest.yml
- CODEOWNERS
- CONTRIBUTING.md
- dependabot.yml
- build-markdown.js
- installer.gif
- logo.png
- logo.svg
- ts-types.png
- authentication.md
- faq.md
- getting-started.md
- how-it-works.md
- installation.md
- making-requests.md
- parameters-and-payloads.md
- server-configurations.md
- upgrading-from-v4.md
- usage.md
- api.js
- buildVersionedFiles.ts
- index.ts
- util.ts
- codegenerator.ts
- factory.ts
- index.ts
- install.ts
- list.ts
- uninstall.ts
- isCI.ts
- prompt.ts
- suggestedOperations.ts
- bin.ts
- fetcher.ts
- lockfileSchema.ts
- logger.ts
- packageInfo.ts
- router.ts
- storage.ts
- index.test.ts
- smoketest.test.ts
- utils.test.ts
- install.test.ts.snap
- list.test.ts.snap
- uninstall.test.ts.snap
- install.test.ts
- list.test.ts
- uninstall.test.ts
- suggestedOperations.test.ts.snap
- suggestedOperations.test.ts
- bin.test.ts
- fetcher.test.ts
- global.d.ts
- router.test.ts
- storage.test.ts
- tsconfig.json
- .gitignore
- .npmignore
- CHANGELOG.md
- legacy-require-handler.cjs
- LICENSE
- package.json
- README.md
- schema.json
- tsconfig.json
- vitest-smoketest.config.ts
- fetchError.ts
- getJSONSchemaDefaults.ts
- index.ts
- parseResponse.ts
- prepareAuth.ts
- prepareParams.ts
- prepareServer.ts
- index.ts
- types.ts
- getJSONSchemaDefaults.test.ts
- parseResponse.test.ts
- prepareAuth.test.ts
- prepareParams.test.ts
- global.d.ts
- index.test.ts
- tsconfig.json
- .gitignore
- .npmignore
- CHANGELOG.md
- LICENSE
- package.json
- README.md
- tsconfig.json
- tsup.config.ts
- index.ts
- index.ts
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- README.md
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- index.ts
- openapi.json
- output.js
- hello.txt
- index.test.ts
- tsconfig.json
- utils.ts
- .gitignore
- .npmignore
- CHANGELOG.md
- LICENSE
- LICENSES
- package.json
- README.md
- tsconfig.json
- tsup.config.ts
- real-world-apis.json
- refresh-dataset
- alby.json
- auth-quirks.json
- basiq.json
- metrotransit.json
- nested-defaults.json
- operationid-quirks.json
- optional-payload.json
- payloads.json
- response-title-quirks.json
- simple.json
- hello.jp.txt
- hello.txt
- owlbert-shrub.png
- owlbert.png
- AmqpExternalRulePatch.ts
- AmqpExternalRulePost.ts
- AmqpExternalRuleResponse.ts
- AmqpRulePatch.ts
- AmqpRulePost.ts
- AmqpRuleResponse.ts
- AppPatch.ts
- AppPkcs12.ts
- AppPost.ts
- AppResponse.ts
- AwsAccessKeys.ts
- AwsAccessKeysResponse.ts
- AwsAssumeRole.ts
- AwsKinesisRulePatch.ts
- AwsKinesisRulePost.ts
- AwsKinesisRuleResponse.ts
- AwsLambdaRulePatch.ts
- AwsLambdaRulePost.ts
- AwsLambdaRuleResponse.ts
- AwsSqsRulePatch.ts
- AwsSqsRulePost.ts
- AwsSqsRuleResponse.ts
- AzureFunctionRulePatch.ts
- AzureFunctionRulePost.ts
- AzureFunctionRuleResponse.ts
- CloudflareWorkerRulePatch.ts
- CloudflareWorkerRulePost.ts
- CloudflareWorkerRuleResponse.ts
- DeleteAppsAppIdNamespacesNamespaceId.ts
- DeleteAppsAppIdQueuesQueueId.ts
- DeleteAppsAppIdRulesRuleId.ts
- DeleteAppsId.ts
- Error.ts
- GetAccountsAccountIdApps.ts
- GetAppsAppIdKeys.ts
- GetAppsAppIdNamespaces.ts
- GetAppsAppIdQueues.ts
- GetAppsAppIdRules.ts
- GetAppsAppIdRulesRuleId.ts
- GoogleCloudFunctionRulePatch.ts
- GoogleCloudFunctionRulePost.ts
- GoogleCloudFunctionRuleResponse.ts
- HttpRulePatch.ts
- HttpRulePost.ts
- HttpRuleResponse.ts
- IftttRulePatch.ts
- IftttRulePost.ts
- IftttRuleResponse.ts
- KeyPatch.ts
- KeyPost.ts
- KeyResponse.ts
- Me.ts
- NamespacePatch.ts
- NamespacePost.ts
- NamespaceResponse.ts
- PatchAppsAppIdKeysKeyId.ts
- PatchAppsAppIdNamespacesNamespaceId.ts
- PatchAppsAppIdRulesRuleId.ts
- PatchAppsId.ts
- PostAccountsAccountIdApps.ts
- PostAppsAppIdKeys.ts
- PostAppsAppIdKeysKeyIdRevoke.ts
- PostAppsAppIdNamespaces.ts
- PostAppsAppIdQueues.ts
- PostAppsAppIdRules.ts
- PostAppsIdPkcs12.ts
- Queue.ts
- QueueResponse.ts
- RulePatch.ts
- RulePost.ts
- RuleResponse.ts
- RuleSource.ts
- UnsupportedRuleResponse.ts
- ZapierRulePatch.ts
- ZapierRulePost.ts
- ZapierRuleResponse.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- Agency.ts
- AlertMessage.ts
- Departure.ts
- Direction.ts
- GetNextripAgencies.ts
- GetNextripDirectionsRouteId.ts
- GetNextripRouteIdDirectionIdPlaceCode.ts
- GetNextripRoutes.ts
- GetNextripStopId.ts
- GetNextripStopsRouteIdDirectionId.ts
- GetNextripVehiclesRouteId.ts
- NexTripResult.ts
- Place.ts
- ProblemDetails.ts
- Route.ts
- Stop.ts
- Vehicle.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- index.ts
- sdk.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- UpdatePetWithForm.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- ApiResponse.ts
- Category.ts
- CreateUsersWithArrayInput.ts
- CreateUsersWithListInput.ts
- DeleteOrder.ts
- DeletePet.ts
- DeleteUser.ts
- FindPetsByStatus.ts
- FindPetsByTags.ts
- GetInventory.ts
- GetOrderById.ts
- GetPetById.ts
- GetUserByName.ts
- LoginUser.ts
- Order.ts
- Pet.ts
- Tag.ts
- UpdatePetWithForm.ts
- UpdateUser.ts
- UploadFile.ts
- User.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- LICENSE
- package.json
- README.md
- tsconfig.json
- AskOwlbot.ts
- Category.ts
- Changelog.ts
- CondensedProjectData.ts
- CreateCategory.ts
- CreateCustomPage.ts
- CreateDoc.ts
- CreateVersion.ts
- CustomPage.ts
- DeleteApiSpecification.ts
- DeleteCategory.ts
- DeleteChangelog.ts
- DeleteCustomPage.ts
- DeleteDoc.ts
- DeleteVersion.ts
- DocSchemaPost.ts
- DocSchemaPut.ts
- DocSchemaResponse.ts
- ErrorApikeyEmpty.ts
- ErrorApikeyMismatch.ts
- ErrorApikeyNotfound.ts
- ErrorCategoryInvalid.ts
- ErrorCategoryNotfound.ts
- ErrorCustompageInvalid.ts
- ErrorCustompageNotfound.ts
- ErrorDocInvalid.ts
- ErrorDocNotfound.ts
- ErrorRegistryNotfound.ts
- ErrorSpecFileEmpty.ts
- ErrorSpecIdDuplicate.ts
- ErrorSpecIdInvalid.ts
- ErrorSpecInvalid.ts
- ErrorSpecInvalidSchema.ts
- ErrorSpecNotfound.ts
- ErrorSpecTimeout.ts
- ErrorSpecVersionNotfound.ts
- ErrorVersionCantDemoteStable.ts
- ErrorVersionCantRemoveStable.ts
- ErrorVersionDuplicate.ts
- ErrorVersionEmpty.ts
- ErrorVersionForkEmpty.ts
- ErrorVersionForkNotfound.ts
- ErrorVersionNotfound.ts
- GetApiRegistry.ts
- GetApiSchema.ts
- GetApiSpecification.ts
- GetCategories.ts
- GetCategory.ts
- GetCategoryDocs.ts
- GetChangelog.ts
- GetChangelogs.ts
- GetCustomPage.ts
- GetCustomPages.ts
- GetDoc.ts
- GetOutboundIPs.ts
- GetProductionDoc.ts
- GetProject.ts
- GetVersion.ts
- GetVersions.ts
- IpListEntry.ts
- SearchDocs.ts
- UpdateApiSpecification.ts
- UpdateCategory.ts
- UpdateChangelog.ts
- UpdateCustomPage.ts
- UpdateDoc.ts
- UpdateVersion.ts
- UploadApiSpecification.ts
- Version.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- GetAnything.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- Category.ts
- FindPetsByStatus.ts
- Pet.ts
- Tag.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- AnimalBase.ts
- AnimalBaseResponse.ts
- AnimalFull.ts
- AnimalFullResponse.ts
- AstronomicalObjectBase.ts
- AstronomicalObjectBaseResponse.ts
- AstronomicalObjectFull.ts
- AstronomicalObjectFullResponse.ts
- AstronomicalObjectHeader.ts
- AstronomicalObjectType.ts
- BloodType.ts
- BookBase.ts
- BookBaseResponse.ts
- BookCollectionBase.ts
- BookCollectionBaseResponse.ts
- BookCollectionFull.ts
- BookCollectionFullResponse.ts
- BookFull.ts
- BookFullResponse.ts
- BookSeriesBase.ts
- BookSeriesBaseResponse.ts
- BookSeriesFull.ts
- BookSeriesFullResponse.ts
- CharacterBase.ts
- CharacterBaseResponse.ts
- CharacterFull.ts
- CharacterFullResponse.ts
- CharacterHeader.ts
- CharacterRelation.ts
- CharacterSpecies.ts
- ComicCollectionBase.ts
- ComicCollectionBaseResponse.ts
- ComicCollectionFull.ts
- ComicCollectionFullResponse.ts
- ComicsBase.ts
- ComicsBaseResponse.ts
- ComicSeriesBase.ts
- ComicSeriesBaseResponse.ts
- ComicSeriesFull.ts
- ComicSeriesFullResponse.ts
- ComicsFull.ts
- ComicsFullResponse.ts
- ComicStripBase.ts
- ComicStripBaseResponse.ts
- ComicStripFull.ts
- ComicStripFullResponse.ts
- CompanyBase.ts
- CompanyBaseResponse.ts
- CompanyFull.ts
- CompanyFullResponse.ts
- CompanyHeader.ts
- ConflictBase.ts
- ConflictBaseResponse.ts
- ConflictFull.ts
- ConflictFullResponse.ts
- ContentLanguage.ts
- ContentRating.ts
- ContentRatingSystem.ts
- Country.ts
- ElementBase.ts
- ElementBaseResponse.ts
- ElementFull.ts
- ElementFullResponse.ts
- EpisodeBase.ts
- EpisodeBaseResponse.ts
- EpisodeFull.ts
- EpisodeFullResponse.ts
- Error.ts
- FoodBase.ts
- FoodBaseResponse.ts
- FoodFull.ts
- FoodFullResponse.ts
- Gender.ts
- Genre.ts
- GetAnimal.ts
- GetAnimalSearch.ts
- GetAstronomicalobject.ts
- GetAstronomicalobjectSearch.ts
- GetBook.ts
- GetBookcollection.ts
- GetBookcollectionSearch.ts
- GetBookSearch.ts
- GetBookseries.ts
- GetBookseriesSearch.ts
- GetCharacter.ts
- GetCharacterSearch.ts
- GetComiccollection.ts
- GetComiccollectionSearch.ts
- GetComics.ts
- GetComicseries.ts
- GetComicseriesSearch.ts
- GetComicsSearch.ts
- GetComicstrip.ts
- GetComicstripSearch.ts
- GetCompany.ts
- GetCompanySearch.ts
- GetConflict.ts
- GetConflictSearch.ts
- GetElement.ts
- GetElementSearch.ts
- GetEpisode.ts
- GetEpisodeSearch.ts
- GetFood.ts
- GetFoodSearch.ts
- GetLiterature.ts
- GetLiteratureSearch.ts
- GetLocation.ts
- GetLocationSearch.ts
- GetMagazine.ts
- GetMagazineSearch.ts
- GetMagazineseries.ts
- GetMagazineseriesSearch.ts
- GetMaterial.ts
- GetMaterialSearch.ts
- GetMedicalcondition.ts
- GetMedicalconditionSearch.ts
- GetMovie.ts
- GetMovieSearch.ts
- GetOccupation.ts
- GetOccupationSearch.ts
- GetOrganization.ts
- GetOrganizationSearch.ts
- GetPerformer.ts
- GetPerformerSearch.ts
- GetSeason.ts
- GetSeasonSearch.ts
- GetSeries.ts
- GetSeriesSearch.ts
- GetSoundtrack.ts
- GetSoundtrackSearch.ts
- GetSpacecraft.ts
- GetSpacecraftclass.ts
- GetSpacecraftclassSearch.ts
- GetSpacecraftSearch.ts
- GetSpecies.ts
- GetSpeciesSearch.ts
- GetStaff.ts
- GetStaffSearch.ts
- GetTechnology.ts
- GetTechnologySearch.ts
- GetTitle.ts
- GetTitleSearch.ts
- GetTradingcard.ts
- GetTradingcarddeck.ts
- GetTradingcarddeckSearch.ts
- GetTradingcardSearch.ts
- GetTradingcardset.ts
- GetTradingcardsetSearch.ts
- GetVideogame.ts
- GetVideogameSearch.ts
- GetVideorelease.ts
- GetVideoreleaseSearch.ts
- GetWeapon.ts
- GetWeaponSearch.ts
- LiteratureBase.ts
- LiteratureBaseResponse.ts
- LiteratureFull.ts
- LiteratureFullResponse.ts
- LocationBase.ts
- LocationBaseResponse.ts
- LocationFull.ts
- LocationFullResponse.ts
- MagazineBase.ts
- MagazineBaseResponse.ts
- MagazineFull.ts
- MagazineFullResponse.ts
- MagazineSeriesBase.ts
- MagazineSeriesBaseResponse.ts
- MagazineSeriesFull.ts
- MagazineSeriesFullResponse.ts
- MaritalStatus.ts
- MaterialBase.ts
- MaterialBaseResponse.ts
- MaterialFull.ts
- MaterialFullResponse.ts
- MedicalConditionBase.ts
- MedicalConditionBaseResponse.ts
- MedicalConditionFull.ts
- MedicalConditionFullResponse.ts
- MovieBase.ts
- MovieBaseResponse.ts
- MovieFull.ts
- MovieFullResponse.ts
- OccupationBase.ts
- OccupationBaseResponse.ts
- OccupationFull.ts
- OccupationFullResponse.ts
- OrganizationBase.ts
- OrganizationBaseResponse.ts
- OrganizationFull.ts
- OrganizationFullResponse.ts
- OrganizationHeader.ts
- PerformerBase.ts
- PerformerBaseResponse.ts
- PerformerFull.ts
- PerformerFullResponse.ts
- Platform.ts
- PostAnimalSearch.ts
- PostAstronomicalobjectSearch.ts
- PostBookcollectionSearch.ts
- PostBookSearch.ts
- PostBookseriesSearch.ts
- PostCharacterSearch.ts
- PostComiccollectionSearch.ts
- PostComicseriesSearch.ts
- PostComicsSearch.ts
- PostComicstripSearch.ts
- PostCompanySearch.ts
- PostConflictSearch.ts
- PostElementSearch.ts
- PostEpisodeSearch.ts
- PostFoodSearch.ts
- PostLiteratureSearch.ts
- PostLocationSearch.ts
- PostMagazineSearch.ts
- PostMagazineseriesSearch.ts
- PostMaterialSearch.ts
- PostMedicalconditionSearch.ts
- PostMovieSearch.ts
- PostOccupationSearch.ts
- PostOrganizationSearch.ts
- PostPerformerSearch.ts
- PostSeasonSearch.ts
- PostSeriesSearch.ts
- PostSoundtrackSearch.ts
- PostSpacecraftclassSearch.ts
- PostSpacecraftSearch.ts
- PostSpeciesSearch.ts
- PostStaffSearch.ts
- PostTechnologySearch.ts
- PostTitleSearch.ts
- PostTradingcarddeckSearch.ts
- PostTradingcardSearch.ts
- PostTradingcardsetSearch.ts
- PostVideogameSearch.ts
- PostVideoreleaseSearch.ts
- PostWeaponSearch.ts
- ProductionRunUnit.ts
- Reference.ts
- ReferenceType.ts
- ResponsePage.ts
- ResponseSort.ts
- ResponseSortClause.ts
- ResponseSortDirection.ts
- SeasonBase.ts
- SeasonBaseResponse.ts
- SeasonFull.ts
- SeasonFullResponse.ts
- SeasonHeader.ts
- SeriesBase.ts
- SeriesBaseResponse.ts
- SeriesFull.ts
- SeriesFullResponse.ts
- SeriesHeader.ts
- SoundtrackBase.ts
- SoundtrackBaseResponse.ts
- SoundtrackFull.ts
- SoundtrackFullResponse.ts
- SpacecraftBase.ts
- SpacecraftBaseResponse.ts
- SpacecraftClassBase.ts
- SpacecraftClassBaseResponse.ts
- SpacecraftClassFull.ts
- SpacecraftClassFullResponse.ts
- SpacecraftClassHeader.ts
- SpacecraftFull.ts
- SpacecraftFullResponse.ts
- SpacecraftType.ts
- SpeciesBase.ts
- SpeciesBaseResponse.ts
- SpeciesFull.ts
- SpeciesFullResponse.ts
- SpeciesHeader.ts
- StaffBase.ts
- StaffBaseResponse.ts
- StaffFull.ts
- StaffFullResponse.ts
- StaffHeader.ts
- TechnologyBase.ts
- TechnologyBaseResponse.ts
- TechnologyFull.ts
- TechnologyFullResponse.ts
- TitleBase.ts
- TitleBaseResponse.ts
- TitleFull.ts
- TitleFullResponse.ts
- TradingCardBase.ts
- TradingCardBaseResponse.ts
- TradingCardDeckBase.ts
- TradingCardDeckBaseResponse.ts
- TradingCardDeckFull.ts
- TradingCardDeckFullResponse.ts
- TradingCardDeckHeader.ts
- TradingCardFull.ts
- TradingCardFullResponse.ts
- TradingCardSetBase.ts
- TradingCardSetBaseResponse.ts
- TradingCardSetFull.ts
- TradingCardSetFullResponse.ts
- TradingCardSetHeader.ts
- VideoGameBase.ts
- VideoGameBaseResponse.ts
- VideoGameFull.ts
- VideoGameFullResponse.ts
- VideoReleaseBase.ts
- VideoReleaseBaseResponse.ts
- VideoReleaseFormat.ts
- VideoReleaseFull.ts
- VideoReleaseFullResponse.ts
- WeaponBase.ts
- WeaponBaseResponse.ts
- WeaponFull.ts
- WeaponFullResponse.ts
- index.ts
- schemas.ts
- sdk.ts
- types.ts
- .gitignore
- package.json
- README.md
- tsconfig.json
- README.md
- CHANGELOG.md
- index.ts
- nock-mocks.ts
- package.json
- tsconfig.json
- vitest.matchers.ts
- vitest.setup.ts
- .gitignore
- .npmrc
- .prettierignore
- CHANGELOG.md
- knip.ts
- LICENSE
- LICENSES
- oxfmt.config.ts
- oxlint.config.ts
- package-lock.json
- package.json
- README.md
- tsconfig.base.json
- tsup.config.ts
- turbo.json
- vitest.config.ts
# μ€μΉ κ°μ΄λ
1. μ½λ λ΄λ €λ°κΈ°
git clone https://github.com/readmeio/api
κΉνλΈμμ νλ‘μ νΈ μ½λ μ 체λ₯Ό λ΄ μ»΄ν¨ν°λ‘ λ΄λ €λ°μ΅λλ€.
cd api
λ°©κΈ λ΄λ €λ°μ νλ‘μ νΈ ν΄λ μμΌλ‘ μ΄λν©λλ€.
2. Node.js
μ¬μ μΆμ²μ¬μ μ€λΉλ¬Ό
npm install
package.jsonμ λͺ μλ λΌμ΄λΈλ¬λ¦¬λ€μ λ΄λ €λ°μ μ€μΉν©λλ€.
npm start
κ°λ°/μ€ν μλ²λ₯Ό μΌλλ€.
λͺ
λ Ήμ΄ μ€ν ν ν°λ―Έλμ λνλλ μ£Όμ(λ³΄ν΅ http://localhost:3000 νν)λ₯Ό λΈλΌμ°μ μμ μ΄μ΄λ³΄μΈμ.
// repository documentation
Was this content helpful?
(0 ratings)