首页 > 代码库 > 开源项目成熟度分析工具-利用github api获取代码库的信息

开源项目成熟度分析工具-利用github api获取代码库的信息

2024-07-09 03:29:31   227人阅读

1.github api

       github api是http形式的api,功能还是比较丰富的，博主因为项目的原因主要用到的是提取project信息这项功能，返回的数据是JSON格式。
api页：https://developer.github.com/v3/
Options: (H) means HTTP/HTTPS only, (F) means FTP only
     --anyauth       Pick "any" authentication method (H)
 -a, --append        Append to target file when uploading (F/SFTP)
     --basic         Use HTTP Basic Authentication (H)
     --cacert FILE   CA certificate to verify peer against (SSL)
     --capath DIR    CA directory to verify peer against (SSL)
 -E, --cert CERT[:PASSWD] Client certificate file and password (SSL)
     --cert-type TYPE Certificate file type (DER/PEM/ENG) (SSL)
     --ciphers LIST  SSL ciphers to use (SSL)
     --compressed    Request compressed response (using deflate or gzip)
 -K, --config FILE   Specify which config file to read
     --connect-timeout SECONDS  Maximum time allowed for connection
 -C, --continue-at OFFSET  Resumed transfer offset
 -b, --cookie STRING/FILE  String or file to read cookies from (H)
 -c, --cookie-jar FILE  Write cookies to this file after operation (H)
     --create-dirs   Create necessary local directory hierarchy
     --crlf          Convert LF to CRLF in upload
     --crlfile FILE  Get a CRL list in PEM format from the given file
 -d, --data DATA     HTTP POST data (H)
     --data-ascii DATA  HTTP POST ASCII data (H)
     --data-binary DATA  HTTP POST binary data (H)
     --data-urlencode DATA  HTTP POST data url encoded (H)
     --delegation STRING GSS-API delegation permission
     --digest        Use HTTP Digest Authentication (H)
     --disable-eprt  Inhibit using EPRT or LPRT (F)
     --disable-epsv  Inhibit using EPSV (F)
 -D, --dump-header FILE  Write the headers to this file
     --egd-file FILE  EGD socket path for random data (SSL)
     --engine ENGINGE  Crypto engine (SSL). "--engine list" for list
 -f, --fail          Fail silently (no output at all) on HTTP errors (H)
 -F, --form CONTENT  Specify HTTP multipart POST data (H)
     --form-string STRING  Specify HTTP multipart POST data (H)
     --ftp-account DATA  Account data string (F)
     --ftp-alternative-to-user COMMAND  String to replace "USER [name]" (F)
     --ftp-create-dirs  Create the remote dirs if not present (F)
     --ftp-method [MULTICWD/NOCWD/SINGLECWD] Control CWD usage (F)
     --ftp-pasv      Use PASV/EPSV instead of PORT (F)
 -P, --ftp-port ADR  Use PORT with given address instead of PASV (F)
     --ftp-skip-pasv-ip Skip the IP address for PASV (F)
     --ftp-pret      Send PRET before PASV (for drftpd) (F)
     --ftp-ssl-ccc   Send CCC after authenticating (F)
     --ftp-ssl-ccc-mode ACTIVE/PASSIVE  Set CCC mode (F)
     --ftp-ssl-control Require SSL/TLS for ftp login, clear for transfer (F)
 -G, --get           Send the -d data with a HTTP GET (H)
 -g, --globoff       Disable URL sequences and ranges using {} and []
 -H, --header LINE   Custom header to pass to server (H)
 -I, --head          Show document info only
 -h, --help          This help text
     --hostpubmd5 MD5  Hex encoded MD5 string of the host public key. (SSH)
 -0, --http1.0       Use HTTP 1.0 (H)
     --ignore-content-length  Ignore the HTTP Content-Length header
 -i, --include       Include protocol headers in the output (H/F)
 -k, --insecure      Allow connections to SSL sites without certs (H)
     --interface INTERFACE  Specify network interface/address to use
 -4, --ipv4          Resolve name to IPv4 address
 -6, --ipv6          Resolve name to IPv6 address
 -j, --junk-session-cookies Ignore session cookies read from file (H)
     --keepalive-time SECONDS  Interval between keepalive probes
     --key KEY       Private key file name (SSL/SSH)
     --key-type TYPE Private key file type (DER/PEM/ENG) (SSL)
     --krb LEVEL     Enable Kerberos with specified security level (F)
     --libcurl FILE  Dump libcurl equivalent code of this command line
     --limit-rate RATE  Limit transfer speed to this rate
 -l, --list-only     List only names of an FTP directory (F)
     --local-port RANGE  Force use of these local port numbers
 -L, --location      Follow redirects (H)
     --location-trusted like --location and send auth to other hosts (H)
 -M, --manual        Display the full manual
     --mail-from FROM  Mail from this address
     --mail-rcpt TO  Mail to this receiver(s)
     --max-filesize BYTES  Maximum file size to download (H/F)
     --max-redirs NUM  Maximum number of redirects allowed (H)
 -m, --max-time SECONDS  Maximum time allowed for the transfer
     --negotiate     Use HTTP Negotiate Authentication (H)
 -n, --netrc         Must read .netrc for user name and password
     --netrc-optional Use either .netrc or URL; overrides -n
     --netrc-file FILE  Set up the netrc filename to use
 -N, --no-buffer     Disable buffering of the output stream
     --no-keepalive  Disable keepalive use on the connection
     --no-sessionid  Disable SSL session-ID reusing (SSL)
     --noproxy       List of hosts which do not use proxy
     --ntlm          Use HTTP NTLM authentication (H)
 -o, --output FILE   Write output to <file> instead of stdout
     --pass PASS     Pass phrase for the private key (SSL/SSH)
     --post301       Do not switch to GET after following a 301 redirect (H)
     --post302       Do not switch to GET after following a 302 redirect (H)
 -#, --progress-bar  Display transfer progress as a progress bar
     --proto PROTOCOLS  Enable/disable specified protocols
     --proto-redir PROTOCOLS  Enable/disable specified protocols on redirect
 -x, --proxy [PROTOCOL://]HOST[:PORT] Use proxy on given port
     --proxy-anyauth Pick "any" proxy authentication method (H)
     --proxy-basic   Use Basic authentication on the proxy (H)
     --proxy-digest  Use Digest authentication on the proxy (H)
     --proxy-negotiate Use Negotiate authentication on the proxy (H)
     --proxy-ntlm    Use NTLM authentication on the proxy (H)
 -U, --proxy-user USER[:PASSWORD]  Proxy user and password
     --proxy1.0 HOST[:PORT]  Use HTTP/1.0 proxy on given port
 -p, --proxytunnel   Operate through a HTTP proxy tunnel (using CONNECT)
     --pubkey KEY    Public key file name (SSH)
 -Q, --quote CMD     Send command(s) to server before transfer (F/SFTP)
     --random-file FILE  File for reading random data from (SSL)
 -r, --range RANGE   Retrieve only the bytes within a range
     --raw           Do HTTP "raw", without any transfer decoding (H)
 -e, --referer       Referer URL (H)
 -J, --remote-header-name Use the header-provided filename (H)
 -O, --remote-name   Write output to a file named as the remote file
     --remote-name-all Use the remote file name for all URLs
 -R, --remote-time   Set the remote file‘s time on the local output
 -X, --request COMMAND  Specify request command to use
     --resolve HOST:PORT:ADDRESS  Force resolve of HOST:PORT to ADDRESS
     --retry NUM   Retry request NUM times if transient problems occur
     --retry-delay SECONDS When retrying, wait this many seconds between each
     --retry-max-time SECONDS  Retry only within this period
 -S, --show-error    Show error. With -s, make curl show errors when they occur
 -s, --silent        Silent mode. Don‘t output anything
     --socks4 HOST[:PORT]  SOCKS4 proxy on given host + port
     --socks4a HOST[:PORT]  SOCKS4a proxy on given host + port
     --socks5 HOST[:PORT]  SOCKS5 proxy on given host + port
     --socks5-hostname HOST[:PORT] SOCKS5 proxy, pass host name to proxy
     --socks5-gssapi-service NAME  SOCKS5 proxy service name for gssapi
     --socks5-gssapi-nec  Compatibility with NEC SOCKS5 server
 -Y, --speed-limit RATE  Stop transfers below speed-limit for ‘speed-time‘ secs
 -y, --speed-time SECONDS  Time for trig speed-limit abort. Defaults to 30
     --ssl           Try SSL/TLS (FTP, IMAP, POP3, SMTP)
     --ssl-reqd      Require SSL/TLS (FTP, IMAP, POP3, SMTP)
 -2, --sslv2         Use SSLv2 (SSL)
 -3, --sslv3         Use SSLv3 (SSL)
     --stderr FILE   Where to redirect stderr. - means stdout
     --tcp-nodelay   Use the TCP_NODELAY option
 -t, --telnet-option OPT=VAL  Set telnet option
     --tftp-blksize VALUE  Set TFTP BLKSIZE option (must be >512)
 -z, --time-cond TIME  Transfer based on a time condition
 -1, --tlsv1         Use TLSv1 (SSL)
     --trace FILE    Write a debug trace to the given file
     --trace-ascii FILE  Like --trace but without the hex output
     --trace-time    Add time stamps to trace/verbose output
     --tr-encoding   Request compressed transfer encoding (H)
 -T, --upload-file FILE  Transfer FILE to destination
     --url URL       URL to work with
 -B, --use-ascii     Use ASCII/text transfer
 -u, --user USER[:PASSWORD]  Server user and password
     --tlsuser USER  TLS username
     --tlspassword STRING TLS password
     --tlsauthtype STRING  TLS authentication type (default SRP)
 -A, --user-agent STRING  User-Agent to send to server (H)
 -v, --verbose       Make the operation more talkative
 -V, --version       Show version number and quit
 -w, --write-out FORMAT  What to output after completion
     --xattr        Store metadata in extended file attributes
 -q                 If used as the first parameter disables .curlrc


2.GET功能

    我们今天获取octokit这个项目的代码库的信息。打开这个项目，如图所示有四个repo

 
   
    打开终端输入以下命令
    
curl -G https://api.github.com/orgs/octokit/repos
  
    这个项目的repo信息就显示了出来（只截取了一部分）。
  
  {
    "id": 10575811,
    "name": "go-octokit",
    "full_name": "octokit/go-octokit",
    "owner": {
      "login": "octokit",
      "id": 3430433,
      "avatar_url": "https://avatars.githubusercontent.com/u/3430433?",
      "gravatar_id": "43f38795089d56a2a7092b7d0c71fa76",
      "url": "https://api.github.com/users/octokit",
      "html_url": "https://github.com/octokit",
      "followers_url": "https://api.github.com/users/octokit/followers",
      "following_url": "https://api.github.com/users/octokit/following{/other_user}",
      "gists_url": "https://api.github.com/users/octokit/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octokit/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octokit/subscriptions",
      "organizations_url": "https://api.github.com/users/octokit/orgs",
      "repos_url": "https://api.github.com/users/octokit/repos",
      "events_url": "https://api.github.com/users/octokit/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octokit/received_events",
      "type": "Organization",
      "site_admin": false
    },
    "private": false,
    "html_url": "https://github.com/octokit/go-octokit",
    "description": "Simple Go wrapper for the GitHub API",
    "fork": false,
    "url": "https://api.github.com/repos/octokit/go-octokit",
    "forks_url": "https://api.github.com/repos/octokit/go-octokit/forks",
    "keys_url": "https://api.github.com/repos/octokit/go-octokit/keys{/key_id}",
    "collaborators_url": "https://api.github.com/repos/octokit/go-octokit/collaborators{/collaborator}",
    "teams_url": "https://api.github.com/repos/octokit/go-octokit/teams",
    "hooks_url": "https://api.github.com/repos/octokit/go-octokit/hooks",
    "issue_events_url": "https://api.github.com/repos/octokit/go-octokit/issues/events{/number}",
    "events_url": "https://api.github.com/repos/octokit/go-octokit/events",
    "assignees_url": "https://api.github.com/repos/octokit/go-octokit/assignees{/user}",
    "branches_url": "https://api.github.com/repos/octokit/go-octokit/branches{/branch}",
    "tags_url": "https://api.github.com/repos/octokit/go-octokit/tags",
    "blobs_url": "https://api.github.com/repos/octokit/go-octokit/git/blobs{/sha}",
    "git_tags_url": "https://api.github.com/repos/octokit/go-octokit/git/tags{/sha}",
    "git_refs_url": "https://api.github.com/repos/octokit/go-octokit/git/refs{/sha}",
    "trees_url": "https://api.github.com/repos/octokit/go-octokit/git/trees{/sha}",
    "statuses_url": "https://api.github.com/repos/octokit/go-octokit/statuses/{sha}",
    "languages_url": "https://api.github.com/repos/octokit/go-octokit/languages",
    "stargazers_url": "https://api.github.com/repos/octokit/go-octokit/stargazers",
    "contributors_url": "https://api.github.com/repos/octokit/go-octokit/contributors",
    "subscribers_url": "https://api.github.com/repos/octokit/go-octokit/subscribers",
    "subscription_url": "https://api.github.com/repos/octokit/go-octokit/subscription",
    "commits_url": "https://api.github.com/repos/octokit/go-octokit/commits{/sha}",
    "git_commits_url": "https://api.github.com/repos/octokit/go-octokit/git/commits{/sha}",
    "comments_url": "https://api.github.com/repos/octokit/go-octokit/comments{/number}",
    "issue_comment_url": "https://api.github.com/repos/octokit/go-octokit/issues/comments/{number}",
    "contents_url": "https://api.github.com/repos/octokit/go-octokit/contents/{+path}",
    "compare_url": "https://api.github.com/repos/octokit/go-octokit/compare/{base}...{head}",
    "merges_url": "https://api.github.com/repos/octokit/go-octokit/merges",
    "archive_url": "https://api.github.com/repos/octokit/go-octokit/{archive_format}{/ref}",
    "downloads_url": "https://api.github.com/repos/octokit/go-octokit/downloads",
    "issues_url": "https://api.github.com/repos/octokit/go-octokit/issues{/number}",
    "pulls_url": "https://api.github.com/repos/octokit/go-octokit/pulls{/number}",
    "milestones_url": "https://api.github.com/repos/octokit/go-octokit/milestones{/number}",
    "notifications_url": "https://api.github.com/repos/octokit/go-octokit/notifications{?since,all,participating}",
    "labels_url": "https://api.github.com/repos/octokit/go-octokit/labels{/name}",
    "releases_url": "https://api.github.com/repos/octokit/go-octokit/releases{/id}",
    "created_at": "2013-06-08T23:50:29Z",
    "updated_at": "2014-06-12T08:34:46Z",
    "pushed_at": "2014-04-08T06:21:29Z",
    "git_url": "git://github.com/octokit/go-octokit.git",
    "ssh_url": "git@github.com:octokit/go-octokit.git",
    "clone_url": "https://github.com/octokit/go-octokit.git",
    "svn_url": "https://github.com/octokit/go-octokit",
    "homepage": "https://github.com/octokit/go-octokit",
    "size": 2900,
    "stargazers_count": 48,
    "watchers_count": 48,
    "language": "Go",
    "has_issues": true,
    "has_downloads": true,
    "has_wiki": false,
    "forks_count": 13,
    "mirror_url": null,
    "open_issues_count": 6,
    "forks": 13,
    "open_issues": 6,
    "watchers": 48,
    "default_branch": "master",
    "permissions": {
      "admin": false,
      "push": false,
      "pull": true
    }
  }
]

/********************************

* 本文来自博客  “李博Garvin“

* 转载请标明出处:http://blog.csdn.net/buptgshengod

******************************************/


联系
我们