{"id":8856,"date":"2016-09-23T11:21:15","date_gmt":"2016-09-23T11:21:15","guid":{"rendered":"https:\/\/dev.railscarma.com\/generate-swagger-docs-rails-api\/"},"modified":"2024-01-10T13:06:39","modified_gmt":"2024-01-10T13:06:39","slug":"generera-swagger-docs-rails-api","status":"publish","type":"post","link":"https:\/\/www.railscarma.com\/sv\/blogg\/tekniska-artiklar\/generera-swagger-docs-rails-api\/","title":{"rendered":"Hur man genererar ett Swagger Docs For Rails API"},"content":{"rendered":"
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Att skapa API f\u00f6r en Rails-applikation \u00e4r enkelt f\u00f6r en Ruby on Rails-utvecklare. Hur som helst, hur olika kunder \/ kunder kommer att veta om API fungerar bra eller inte utan en applikation p\u00e5 kundsidan. Finns det n\u00e5got svar p\u00e5 detta som jag kan rapportera f\u00f6r API inuti Rails-applikationen, svaret \u00e4r ja vi har m\u00e5nga instrument och metoder men jag skulle f\u00f6redra swagger UI.<\/p>\n

I den h\u00e4r artikeln kommer jag att avsl\u00f6ja hur man g\u00f6r Rails API-dokumentation med hj\u00e4lp av swagger UI.<\/p>\n

F\u00f6rkunskapskrav: -
Jag kommer att anv\u00e4nda en exempelpostapplikation som tj\u00e4nar API-anrop.<\/p>\n

Gem: -
F\u00f6r att integrera swagger UI f\u00f6r Rails API anv\u00e4nder jag en p\u00e4rla som heter swagger-docs. L\u00e4gg till den h\u00e4r p\u00e4rlan i din Gemfile i din applikation och g\u00f6r bundle-installation.<\/p>\n

Swagger-initialiseringsfil: -
N\u00e4r du har buntat ihop p\u00e4rlan skapar du en initialiserare i config\/initializers (t.ex. swagger.rb) och anger f\u00f6ljande alternativ:<\/p>\n

#File config\/initializers\/swagger.rb Swagger::Docs::Config.register_apis({ "1.0" => { # till\u00e4gget som anv\u00e4nds f\u00f6r API:et :api_extension_type => :json, # utdataplatsen d\u00e4r dina .json-filer skrivs till :api_file_path => "public\/apidocs", # URL-bass\u00f6kv\u00e4gen till ditt API :base_path => "http:\/\/localhost:3000", # om du vill ta bort alla .json-filer vid varje generation :clean_directory => true, # l\u00e4gg till anpassade attribut till api-docs :attributes => { :info => { "title" =>; "Din applikationstitel", "description" =>; "Rails API-dokumentation med Swagger UI.", "termsOfServiceUrl". " => "", "kontakt" => "" } } } })\n<\/code><\/pre>\n
Se nedanst\u00e5ende webbadress f\u00f6r en lista \u00f6ver konfigurationer
https:\/\/github.com\/richhollis\/swagger-docs#configuration-options<\/p>\n
swagger_controller och swagger_API \u00e4r hj\u00e4lpmedel f\u00f6r att tillhandah\u00e5lla dokumentation av swaggergr\u00e4nssnittet.<\/p>\n
\nmodul Api-modul V1 klass PostsController < ApplicationController respond_to :json swagger_controller :posts, 'Post Controller' swagger_api :create g\u00f6r sammanfattning 'Skapa inl\u00e4gg'-anteckningar 'B\u00f6r anv\u00e4ndas f\u00f6r att skapa inl\u00e4gg' param :form, 'post[name]', :string , :required, 'name' param :form, 'post[publish]', :boolean, :required, 'publish' end swagger_api :index do summary 'H\u00e4mta alla inl\u00e4gg' anteckningar 'B\u00f6r anv\u00e4ndas f\u00f6r att h\u00e4mta alla inl\u00e4gg' param :header, :Auktorisation, :string, :required, 'Authorization'-svar :obeh\u00f6rigt svar :ok, "Framg\u00e5ng" end swagger_api :show g\u00f6r sammanfattning 'H\u00e4mta alla inl\u00e4gg' anteckningar 'B\u00f6r anv\u00e4ndas f\u00f6r att h\u00e4mta ett inl\u00e4gg' param :path , :id, :string, :id-svar :obeh\u00f6rigt svar :ok, "Framg\u00e5ng" end swagger_api :destroy g\u00f6r sammanfattning 'F\u00f6rst\u00f6r inl\u00e4gget'-anteckningar 'B\u00f6r anv\u00e4ndas f\u00f6r att f\u00f6rst\u00f6ra ett inl\u00e4gg' param :s\u00f6kv\u00e4g, :id, :str\u00e4ng, :id-svar :otill\u00e5tet svar :ok, "Framg\u00e5ng" slut slut slut slut\n<\/code><\/pre>\n
Ex:-<\/p>\n
param :header, :Authorization, :string, :required, 'F\u00f6r att auktorisera f\u00f6rfr\u00e5gningarna.' param :s\u00f6kv\u00e4g, :id, :integer, :required, 'post-id som ska h\u00e4mta posten' param :form, :name, :string, :valfritt, 'namn p\u00e5 inl\u00e4gget' param :query, :query_name, : str\u00e4ng, :valfritt, 'fr\u00e5gans namn'<\/code><\/pre>\n
param \u2013 Standard API-parameter<\/p>\n
 f\u00f6rsta v\u00e4rdet: parameter_type(typer: form, s\u00f6kv\u00e4g, rubrik, fr\u00e5ga) andra v\u00e4rdet: namnet p\u00e5 parametern tredje v\u00e4rdet: datatyp f\u00f6r parametern fj\u00e4rde v\u00e4rde: obligatoriskt\/valfritt femte v\u00e4rdet: Liten beskrivning av parametern sj\u00e4tte v\u00e4rdet: lista \u00f6ver v\u00e4rden i fyrkantiga f\u00e4sten f\u00f6r att hantera enums (valfritt)<\/code><\/pre>\n
F\u00f6r att hantera enumer:-
Skicka en lista med enumv\u00e4rden.
Ex:-<\/p>\n
param_list :form, :payment_type, :string, :required, 'payment type', [:check, :cash, :wire_transfer, :demand_draft]<\/code><\/pre>\n
Generering av json-filer<\/p>\n
rake swagger:docs (Fel visas inte som standard med detta kommando)<\/p>\n
Om du vill se alla felmeddelanden anv\u00e4nder du kommandot nedan:<\/p>\n
SD_LOG_LEVEL=1 rake swagger:docs<\/code><\/pre>\n
Swagger UI-integration<\/p>\n
V\u00e4nligen ladda ner swagger ui.
https:\/\/github.com\/richhollis\/swagger-docs-sample\/tree\/master\/public\/api<\/a><\/p>\n
Innan du g\u00f6r det, l\u00e4gg till nedanst\u00e5ende kod i swagger.rb f\u00f6r att
g\u00f6ra en \u00e5tskillnad mellan API:er och API-dokumentationss\u00f6kv\u00e4gar.<\/p>\n
class Swagger::Docs::Config def self.transform_path(path, api_version) # G\u00f6r en skillnad mellan API:er och API-dokumentationsv\u00e4gar. "apidocs\/#{path}" slutet<\/code><\/pre>\n
Skapa katalogen apidocs under public och katalogen api under apidocs.<\/p>\n
Kopiera nedladdad swagger-ui till public\/apidocs\/api och index.html till public\/apidocs.<\/p>\n
Redigera index.html
\u00c4ndra swagger url i window.swaggerUi funktionen till url: \u201c\/apidocs\/api-docs.json\u201d.
Den ska peka p\u00e5 filen api-docs.json under public\/apidocs.
Eftersom det kommer att genereras under den s\u00f6kv\u00e4gen enligt den konfiguration som vi definierade i swagger.rb<\/p>\n
Nu \u00e4r vi alla redo. OM du k\u00f6r servern, stoppa och starta om rails-servern. G\u00e5 till webbl\u00e4saren och f\u00f6rs\u00f6k att komma \u00e5t \"http:\/\/localhost:3000\/apidocs\/index\u00e2\u20ac. Du kan klicka p\u00e5 tillg\u00e4ngliga l\u00e4nkar (visa \/ d\u00f6lja, lista operationer, expandera operationer och r\u00e5) p\u00e5 varje resurs (inl\u00e4gg etc.):<\/p>\n
\"swagger-doc-1\"<\/a> \"swagger-doc-2\"<\/a><\/p>\n
L\u00e4s \u00e4ven: Sp\u00e5ra \u00e4ndringar i din modells data med Paper Trail Gem<\/a><\/p>\n
L\u00e4s ocks\u00e5 :  Arkitektur f\u00f6r flera hyresg\u00e4ster med PostgreSQL-scheman<\/a><\/p>\n
Vill du l\u00e4ra dig mer om v\u00e5ra Rails-utvecklingsf\u00e4rdigheter och tidigare projekt? Komma i kontakt<\/a> med oss nu!  <\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t
Prenumerera f\u00f6r de senaste uppdateringarna<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t
\t\t\t\t\t